README.md

   1 # docvim: a documentation generator for Vim plug-ins
   2
   3 docvim is a documentation generator for Vim plug-ins, written in Haskell.
   4
   5 ## Development
   6
   7 ### Running
   8
   9 Run using `cabal` and passing in docvim-specific `OPTIONS`:
  10
  11 ```
  12 cabal run -- [OPTIONS]
  13 ```
  14
  15 You can also run the modules from inside the Cabal REPL:
  16
  17 ```
  18 cabal repl
  19 > let sample = "let l:test=1"
  20 > l sample -- prints lexed tokens
  21 > p sample -- prints AST
  22 ```
  23
  24 ### Building and viewing the code-level documentation
  25
  26 ```
  27 cabal haddock --executables
  28 open dist/doc/html/docvim/docvim/index.html
  29 ```
  30
  31 ### Testing
  32
  33 ```
  34 cabal test
  35 ```
  36
  37 ### Linting
  38
  39 ```
  40 cabal install hlint
  41 hlint src # or, alternatively...
  42 cabal test
  43 ```