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: nits

Browse Source
This commit is contained in:
Jonathan Daugherty 2017-08-27 20:03:20 -07:00
parent cc29ea6250
commit 53b6ccdefa
1 changed files with 12 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -70,8 +70,18 @@ $ cabal install -j -f demos
$ .cabal-sandbox/bin/brick-???-demo $ .cabal-sandbox/bin/brick-???-demo
``` ```
To get started, see the [first few sections of the brick To get started, see the [user guide](https://github.com/jtdaugherty/brick/blob/master/docs/guide.rst).
user guide](https://github.com/jtdaugherty/brick/blob/master/docs/guide.rst).
Documentation
-------------
Documentation for `brick` comes in a variety of forms:
* [The 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)
* Haddock (all modules)
* [Demo programs](https://github.com/jtdaugherty/brick/blob/master/programs)
* [FAQ](https://github.com/jtdaugherty/brick/blob/master/FAQ.md)
Feature Overview Feature Overview
---------------- ----------------
@ -104,17 +114,6 @@ library changes, give feedback, and ask questions. You can subscribe at:
[https://groups.google.com/group/brick-users](https://groups.google.com/group/brick-users) [https://groups.google.com/group/brick-users](https://groups.google.com/group/brick-users)
Documentation
-------------
Your documentation options, in recommended order, are:
* [FAQ](https://github.com/jtdaugherty/brick/blob/master/FAQ.md)
* [The 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)
* Haddock (all modules)
* [Demo programs](https://github.com/jtdaugherty/brick/blob/master/programs)
Status Status
------ ------