]> git.wincent.com - docvim.git/commitdiff
Set up cabal sandbox
authorGreg Hurrell <greg@hurrell.net>
Wed, 23 Mar 2016 03:36:15 +0000 (20:36 -0700)
committerGreg Hurrell <greg@hurrell.net>
Wed, 23 Mar 2016 03:36:15 +0000 (20:36 -0700)
To try to hopefully avoid some clowntownery later on.

Reference: http://coldwa.st/e/blog/2013-08-20-Cabal-sandbox.html

.gitignore [new file with mode: 0644]
README.md

diff --git a/.gitignore b/.gitignore
new file mode 100644 (file)
index 0000000..ba561ab
--- /dev/null
@@ -0,0 +1,2 @@
+/.cabal-sandbox
+/cabal.sandbox.config
index 1f81f176194b18a2f6c6edf4b0f58afcb2032545..5e24be348690504883757b012c884fbd3d2f0b3e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,9 +4,17 @@ docvim is a documentation generator for Vim plug-ins, written in Haskell.
 
 ## Development
 
+### Set-up
+
+```
+cabal sandbox init
+cabal install --only-dependencies --enable-tests
+cabal build
+```
+
 ### Running
 
-Run using `cabal` and passing in docvim-specific `OPTIONS`:
+Run using `cabal run` and passing in docvim-specific `OPTIONS`:
 
 ```
 cabal run -- [OPTIONS]
@@ -16,9 +24,9 @@ You can also run the modules from inside the Cabal REPL:
 
 ```
 cabal repl
+> import Docvim.Parse
 > let sample = "let l:test=1"
-> l sample -- prints lexed tokens
-> p sample -- prints AST
+> pp sample -- pretty-prints AST
 ```
 
 ### Building and viewing the code-level documentation