Readme for haskdogs-0.2
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' via
SHS so this tool will probably work on Linuxes and maybe Macs. Pure Windows
will fail to run it.
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. Make shure that $HOME/.cabal/var/haskdogs does exist.
3. cd to your Haskell project dir
4. run haskdogs
--
Sergey
<ierton@gmail.com>