ilyakooo0/reflex-vty
1
0
Fork 0
mirror of https://github.com/ilyakooo0/reflex-vty.git synced 2024-11-22 10:53:32 +03:00
Code Issues Projects Releases Wiki Activity
Build terminal applications using functional reactive programming (FRP) with Reflex FRP.
279 Commits 25 Branches 10 Tags 807 KiB
Haskell 99.2%
Nix 0.8%
93033d2828
Go to file
Ali Abrar 93033d2828 ci: disable macos github workflow
2021-10-05 15:17:48 -04:00
.github/workflows ci: disable macos github workflow 2021-10-05 15:17:48 -04:00
doc Use imgur-hosted welcome GIF 2020-06-15 14:11:33 -04:00
reflex-platform Backport GHC 8.10 support for last release 2021-06-14 22:05:37 -04:00
src Merge branch 'develop' into TextAlignConsolidate 2021-09-16 11:44:03 -04:00
src-bin fix examples 2021-04-11 17:08:26 -07:00
test fix offsetMap computation to include cursor character 2021-07-02 10:52:22 -07:00
.gitignore Update .gitignore 2020-06-05 17:09:53 -04:00
ChangeLog.md Merge branch 'develop' into TextAlignConsolidate 2021-09-16 11:44:03 -04:00
CONTRIBUTING.md Add contribution guide, changelog, release.nix 2019-08-03 20:06:51 -04:00
LICENSE Update license 2018-02-27 12:51:37 -05:00
README.md nix: simplify nix-shell instructions 2021-03-11 21:24:53 -05:00
reflex-vty.cabal Merge remote-tracking branch 'origin/release/0.1.4' into develop 2021-06-15 14:13:14 -04:00
release.nix ci: fix nix build 2021-03-11 21:22:27 -05:00
Setup.hs Reflex host for Graphics.Vty 2018-02-25 16:58:54 -05:00
shell.nix nix: simplify nix-shell instructions 2021-03-11 21:24:53 -05:00

README.md

reflex-vty

Haskell Hackage Hackage CI Travis CI BSD3 License

Build terminal applications using functional reactive programming (FRP) with Reflex FRP.

Example Animation

Feature requests, pull requests, and other feedback are welcome and appreciated (see the contribution guide). This library is still experimental, so big changes are possible!

How to Build

With reflex-platform

Enter a nix-shell for the project:

git clone https://github.com/reflex-frp/reflex-vty.git
cd reflex-vty
nix-shell

From within the nix-shell you can:

  • Run the example: cabal repl example
  • Load the library in the repl: cabal repl reflex-vty
  • Build the example executable: cabal build example
  • Build the docs: cabal haddock
  • Run ghcid for immediate compiler feedback when you save a .hs file: ghcid -c "cabal repl reflex-vty --ghc-options=-Wall"
  • etc.

With cabal

Please see the tested-with field of the cabal file for known-compatible versions of GHC.

From the reflex-vty project directory:

# nix-shell -p cabal-install binutils icu # for nix users
cabal new-configure
cabal new-build # to build the library and example
cabal new-repl # to enter a repl for the library
cabal new-repl example # to enter a repl for the example executable