git.iko.soy/reflex-vty
on ecc299a help sign in
reflex-vty/README.md
31 lines 840 B history raw
1# reflex-vty
3![reflex-vty example animation](doc/welcome.gif)
5## A library for building functional reactive terminal applications
7### How to Build
9#### With reflex-platform
11Enter a nix-shell for the project:
12```bash
13git clone git@github.com:reflex-frp/reflex-platform
14git clone git@gitlab.com:obsidian.systems/reflex-vty
15cd reflex-vty
16../reflex-platform/scripts/work-on ghc ./.
17```
19From within the nix-shell you can:
20* Run the example: `cabal repl example`
21* Load the library in the repl: `cabal repl reflex-vty`
22* Build the example executable: `cabal build example`
23* Build the docs: `cabal haddock`
24* etc.
26### Contributing
28Feature requests, pull requests, and other feedback are welcome and appreciated. This library
29is still experimental, so big changes are possible!
31Please make sure contributions have 100% haddocks coverage.