Commits

John Lenz committed e5f106d

Add a quickstart section to the readme

Comments (0)

Files changed (1)

       editor.
 * Execute a raw notmuch command and view the results
 
+# Quickstart
+
+To quickly test out the client on linux, make sure you have libgmp and zlib installed, [download the latest
+binary](https://bitbucket.org/wuzzeb/notmuch-web/downloads), extract the tarball, then run
+
+~~~ {.bash}
+$ mv config/settings.example.yml config/settings.yml
+$ ./notmuch-web Testing
+~~~
+
+You can now visit [http://localhost:3000](http://localhost:3000) and use "hunter2" as the password.
 
 # Install
 
 version on [hackage](http://hackage.haskell.org/package/notmuch-web).  To do this, from the shell
 run
 
-~~~
-# cabal update
-# cabal install yesod-platform notmuch-web
+~~~ {.bash}
+$ cabal update
+$ cabal install yesod-platform notmuch-web
 ~~~
 
 You must mention both yesod-platform and notmuch-web on the same install line to make sure all