Build terminal applications using functional reactive programming (FRP) with Reflex FRP.
Go to file
Ali Abrar 7644ab6aad
Merge pull request #8 from reflex-frp/aa-fullwidth-unicode
Handle wrapping of lines containing fullwidth unicode characters
2019-09-07 15:32:45 -04:00
doc Add another example image 2018-11-05 02:43:28 -05:00
reflex-platform Fix some version bounds; Remove GHC822 from CI; Build against stable and unstable reflex-platform 2019-08-04 12:44:11 -04:00
src Fix haddock code formatting 2019-09-07 15:18:31 -04:00
src-bin Create Reflex.Vty.Widget.Layout; Make shutdown cleaner on exceptions 2019-08-03 21:14:37 -04:00
.gitignore Add gitignore 2018-11-04 11:48:45 -05:00
.travis.yml Fix some version bounds; Remove GHC822 from CI; Build against stable and unstable reflex-platform 2019-08-04 12:44:11 -04:00
ChangeLog.md Bump to 0.1.2.0 2019-09-07 15:08:36 -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 Update README.md 2019-08-16 18:37:59 -04:00
reflex-vty.cabal Bump to 0.1.2.0 2019-09-07 15:08:36 -04:00
release.nix Fix some version bounds; Remove GHC822 from CI; Build against stable and unstable reflex-platform 2019-08-04 12:44:11 -04:00
Setup.hs Reflex host for Graphics.Vty 2018-02-25 16:58:54 -05:00

reflex-vty hackage hackage-ci travis-ci

A library for building functional reactive terminal applications

reflex-vty 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 git@github.com:reflex-frp/reflex-platform
git clone git@github.com:reflex-frp/reflex-vty
cd reflex-vty
../reflex-platform/scripts/work-on ghc ./.

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:

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