aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e3cfc7f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+cucutags provides a simple generator of ctags-like tags file for
+the combination of [Gherkin language features](https://github.com/cucumber/cucumber/wiki/Gherkin) and Python [steps](https://github.com/behave/behave).
+
+Unfortunately, no text editor known to me is able to use so
+generated tags file. However, this script can be also used by any
+other Python script as a library, and thus for example
+[vim](http://www.vim.org) can use it via
+[vim-behave](https://gitorious.org/cucutags/vim-behave) plugin.
+
+All bug reports and enhancement requests, please, send to the
+email listed in the script file.