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

Update README

Browse Source
This commit is contained in:
Jonathan Daugherty 2015-07-23 23:11:49 -07:00
parent 2a31830b55
commit f74cf72572
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -55,10 +55,7 @@ function named `thing` has a `lens` version, the `lens` version is named
Getting Started Getting Started
--------------- ---------------
The best way to get started is to build, run, and read the source for TLDR:
the various demonstration programs in the `programs/` directory. This
will help you get to know the library and what it can do. There is also
extensive Haddock documentation.
``` ```
$ cabal sandbox init $ cabal sandbox init
@ -66,6 +63,17 @@ $ 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
manual](docs/index.rst).
Documentation
-------------
Your documentation options, in recommended order, are:
* [The brick manual](docs/index.rst)
* Haddock (all modules)
Status Status
------ ------