git.iko.soy/reflex-vty
on aa-scrollabletext help sign in
reflex-vty/README.md
42 lines 1.7 kB history raw
1# reflex-vty [![hackage](https://img.shields.io/hackage/v/reflex-vty.svg)](https://hackage.haskell.org/package/reflex-vty) [![hackage-ci](https://matrix.hackage.haskell.org/api/v2/packages/reflex-vty/badge)](https://matrix.hackage.haskell.org/#/package/reflex-vty) [![travis-ci](https://api.travis-ci.org/reflex-frp/reflex-vty.svg?branch=develop)](https://travis-ci.org/reflex-frp/reflex-vty)
3## A library for building functional reactive terminal applications
5![reflex-vty example animation](doc/welcome.gif)
7Feature requests, pull requests, and other feedback are welcome and appreciated (see the [contribution guide](CONTRIBUTING.md)). This library
8is still experimental, so big changes are possible!
9### How to Build
11#### With reflex-platform
13Enter a nix-shell for the project:
14```bash
15git clone git@github.com:reflex-frp/reflex-platform
16git clone git@github.com:reflex-frp/reflex-vty
17cd reflex-vty
18../reflex-platform/scripts/work-on ghc ./.
19```
21From within the nix-shell you can:
22* Run the example: `cabal repl example`
23* Load the library in the repl: `cabal repl reflex-vty`
24* Build the example executable: `cabal build example`
25* Build the docs: `cabal haddock`
26* Run ghcid for immediate compiler feedback when you save a .hs file: `ghcid -c "cabal repl reflex-vty --ghc-options=-Wall"`
27* etc.
29#### With cabal
31Please see the `tested-with` field of the cabal file for known-compatible versions of GHC.
33From the reflex-vty project directory:
35```bash
36cabal new-configure
37cabal new-build # to build the library and example
38cabal new-repl # to enter a repl for the library
39cabal new-repl example # to enter a repl for the example executable
40```