Commits

abudden  committed 8467567

Improved description for github.

  • Participants
  • Parent commits a7bc4c1

Comments (0)

Files changed (1)

-This repository contains the source code for the Vim TagHighlight plugin.
+TagHighlight is a plugin that highlights names of classes, variables, types etc in source code in Vim.  This makes it quicker and easier to spot errors in your code.  By using exuberant ctags and parsing the output, the typedefs, #defines, enumerated names etc are all clearly highlighted in different colours.  As standard, it supports the following languages (but it's very easy to add more):
+
+* C/C++ (most of the testing has been with these);
+* C#
+* Java
+* Perl
+* PHP
+* Python
+* Ruby
+* VHDL (if your version of ctags supports it)
+
+Adding more languages is extremely simple.
+
+To show the benefit of this plugin, there are some screenshots and a more detailed description at the following website:
+
+    [http://www.cgtk.co.uk/taghighlight]
+
+Installation instructions are available here:
+
+    [http://www.cgtk.co.uk/taghighlight/install]
 
 Detailed documentation can be found in [doc/TagHighlight.txt](https://github.com/abudden/TagHighlight/blob/master/doc/TagHighlight.txt).