mirror of
https://github.com/jtdaugherty/brick.git
synced 2024-10-27 09:38:28 +03:00
Update README
This commit is contained in:
parent
2a31830b55
commit
f74cf72572
16
README.md
16
README.md
@ -55,10 +55,7 @@ function named `thing` has a `lens` version, the `lens` version is named
|
||||
Getting Started
|
||||
---------------
|
||||
|
||||
The best way to get started is to build, run, and read the source for
|
||||
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.
|
||||
TLDR:
|
||||
|
||||
```
|
||||
$ cabal sandbox init
|
||||
@ -66,6 +63,17 @@ $ cabal install -j -f demos
|
||||
$ .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
|
||||
------
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user