Readme for haskdogs-0.3.1
INFO
====
haskdogs is a small shellscript-like tool which creates tag file for entire
haskell project directory. It takes into account first-level dependencies by
recursively scanning imports and adding matching packages to the final
tag list.
As a result, programmer can use his/her text editor supporting tags (vim, for
example) to jump directly to definition of any standard or foreign function
he/she uses.
Note, that haskdogs calls some Unix shell commands like 'test' or 'mkdir'
so this tool will run, but probably fail to work on pure Windows platforms.
INSTALL
=======
0. cabal install hasktags
1. git clone https://github.com/ierton/haskdogs
2. cd haskdogs
3. cabal install
4. export PATH="$HOME/.cabal/bin:$PATH"
RUNNING
=======
1. Make sure yoy have installed hasktags and put it in PATH. Hasktags is being
called by haskdogs by name.
2. cd to your Haskell project dir
3. run haskdogs (cmdline args will be passed to hasktags followed by a filelist generated)
--
Sergey
<ierton@gmail.com>