ilyakooo0/reflex-vty
1
0
Fork 0
mirror of https://github.com/ilyakooo0/reflex-vty.git synced 2024-11-26 12:01:58 +03:00
Code Issues Projects Releases Wiki Activity

Add readme

Browse Source
This commit is contained in:
Ali Abrar 2018-11-05 03:00:59 -05:00
parent 09e1a13eda
commit e72b38363d
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md Normal file
View File

@ -0,0 +1,29 @@
# reflex-vty
## A library for building functional reactive terminal applications
### How to Build
#### With reflex-platform
Enter a nix-shell for the project:
```bash
git clone git@github.com:reflex-frp/reflex-platform
git clone git@gitlab.com:obsidian.systems/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`
* etc.
### Contributing
Feature requests, pull requests, and other feedback are welcome and appreciated. This library
is still experimental, so big changes are possible!
Please make sure contributions have 100% haddocks coverage.