jtdaugherty/brick
1
1
Fork 0
mirror of https://github.com/jtdaugherty/brick.git synced 2024-11-29 10:54:48 +03:00
Code Issues Projects Releases Wiki Activity

README: various updates

Browse Source
This commit is contained in:
Jonathan Daugherty 2017-12-10 21:14:06 -08:00
parent f4e08507d0
commit 2254a39677
1 changed files with 9 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -20,8 +20,6 @@ Under the hood, this library builds upon
[vty](http://hackage.haskell.org/package/vty), so some knowledge of Vty [vty](http://hackage.haskell.org/package/vty), so some knowledge of Vty
will be helpful in using this library. will be helpful in using this library.
This library deprecates [vty-ui](https://github.com/jtdaugherty/vty-ui).
Example Example
------- -------
@ -66,12 +64,12 @@ at these projects:
Getting Started Getting Started
--------------- ---------------
TLDR: Check out the many demo programs to get a feel for different aspects of
the library:
``` ```
$ cabal sandbox init $ cabal new-build -f demos
$ cabal install -j -f demos $ find dist-newstyle -type f -name \*-demo
$ .cabal-sandbox/bin/brick-???-demo
``` ```
To get started, see the [user guide](https://github.com/jtdaugherty/brick/blob/master/docs/guide.rst). To get started, see the [user guide](https://github.com/jtdaugherty/brick/blob/master/docs/guide.rst).
@ -81,7 +79,7 @@ Documentation
Documentation for `brick` comes in a variety of forms: Documentation for `brick` comes in a variety of forms:
* [The brick user guide](https://github.com/jtdaugherty/brick/blob/master/docs/guide.rst) * [The official brick user guide](https://github.com/jtdaugherty/brick/blob/master/docs/guide.rst)
* [Samuel Tay's brick tutorial](https://github.com/jtdaugherty/brick/blob/master/docs/samtay-tutorial.md) * [Samuel Tay's brick tutorial](https://github.com/jtdaugherty/brick/blob/master/docs/samtay-tutorial.md)
* Haddock (all modules) * Haddock (all modules)
* [Demo programs](https://github.com/jtdaugherty/brick/blob/master/programs) * [Demo programs](https://github.com/jtdaugherty/brick/blob/master/programs)
@ -123,10 +121,10 @@ Status
------ ------
There are some places were I have deliberately chosen to worry about There are some places were I have deliberately chosen to worry about
performance later for the sake of spending more time on the design (and performance later for the sake of spending more time on the design
to wait on performance issues to arise first). `brick` is also something (and to wait on performance issues to arise first). `brick` is also
of an experimental project of mine and some aspects of the design something of an experimental project of mine and some aspects of the
involve trade-offs that may are not entirely settled. In addition you design involve trade-offs that are not entirely settled. In addition you
can expect this library to follow a principle of fearless improvement: can expect this library to follow a principle of fearless improvement:
new versions will make (sometimes substantial) API changes if those new versions will make (sometimes substantial) API changes if those
changes really do make the library better. I will place more importance changes really do make the library better. I will place more importance