From f74cf72572bfc778f08bc05f65c379e59f65abf6 Mon Sep 17 00:00:00 2001 From: Jonathan Daugherty Date: Thu, 23 Jul 2015 23:11:49 -0700 Subject: [PATCH] Update README --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 425a6cb..107e320 100644 --- a/README.md +++ b/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 ------