@@ -0,0 +1,29 @@
1+# reflex-vty
2+
3+## A library for building functional reactive terminal applications
4+
5+### How to Build
6+
7+#### With reflex-platform
8+
9+Enter a nix-shell for the project:
10+```bash
11+git clone git@github.com:reflex-frp/reflex-platform
12+git clone git@gitlab.com:obsidian.systems/reflex-vty
13+cd reflex-vty
14+../reflex-platform/scripts/work-on ghc ./.
15+```
16+
17+From within the nix-shell you can:
18+* Run the example: `cabal repl example`
19+* Load the library in the repl: `cabal repl reflex-vty`
20+* Build the example executable: `cabal build example`
21+* Build the docs: `cabal haddock`
22+* etc.
23+
24+### Contributing
25+
26+Feature requests, pull requests, and other feedback are welcome and appreciated. This library
27+is still experimental, so big changes are possible!
28+
29+Please make sure contributions have 100% haddocks coverage.