Skip to content

Commit

Permalink
Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ptek committed Sep 27, 2011
1 parent 965acec commit 33f4fcf
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@

.#*
\#*
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# hasktags emacs

This library provides useful functionality to emacs for usage with hasktags program

# usage

To be able to navigate through Your haskell code in emacs faster, You may want to tag Your code and use etags library supplied with emacs to do that.

One of such tools is hasktags and You can find some information on it on [Haskell Wiki](http://www.haskell.org/haskellwiki/Hasktags#Haskell_tag_generators)
The program itself can be found in [Hackage](http://hackage.haskell.org/package/hasktags)

To use the tags automatically, I've created a script for emacs, which would regenerate the TAGS when You save your file.

So, please install hasktags first:

cabal install hasktags

clone the project directory into your preferred location for emacs tools

git clone https://Kerestey@github.com/Kerestey/hasktags-emacs.git

and add these two lines into your .emacs file

(add-to-list 'load-path "<path-to-hasktags-emacs-directory>")
(load "hasktags")


To help emacs locate Your project correctly, You will have to create TAGS file in Your project root directory.
Just `echo -n > TAGS` and You are good to go.

You can now navigate to the function definitions using `M-.` and also use the other functionalities described in http://www.emacswiki.org/emacs/EmacsTags

0 comments on commit 33f4fcf

Please sign in to comment.