Mercurial > vim-gutentags
diff README.md @ 22:4e1b0253f71a
Renamed project to "Gutentags" (thanks Sylvain!).
author | Ludovic Chabant <ludovic@chabant.com> |
---|---|
date | Tue, 02 Sep 2014 10:31:09 -0700 |
parents | b13e1141aa5c |
children | 5c1baa6007d8 |
line wrap: on
line diff
--- a/README.md Mon Sep 01 08:48:48 2014 -0700 +++ b/README.md Tue Sep 02 10:31:09 2014 -0700 @@ -1,43 +1,43 @@ -# Autotags +# Gutentags -Autotags is a plugin that takes care of the much needed management of tags +Gutentags is a plugin that takes care of the much needed management of tags files in Vim. It will (re)generate tag files as you work while staying completely out of your way. It will even do its best to keep those tag files out of your way too. It has no dependencies and just works. ## How? -Install Autotags like any other Vim plugin. I recommend something like +Install Gutentags like any other Vim plugin. I recommend something like [Pathogen][], so you can go: cd ~/.vim/bundle - hg clone https://bitbucket.org/ludovicchabant/vim-autotags + hg clone https://bitbucket.org/ludovicchabant/vim-gutentags Then you only need to do a `:call pathogen#helptags()` to generate the documentation tags (how ironic, eh?) and you can access Autotag's help pages -with `help autotags`. +with `help gutentags`. ## What? -In order to generate tag files, Autotags will have to figure out what's in +In order to generate tag files, Gutentags will have to figure out what's in your project. To do this, it will locate well-known project root markers like SCM folders (`.git`, `.hg`, etc.), any custom tags you define (with -`autotags_project_root`), and even things you may have defined already with +`gutentags_project_root`), and even things you may have defined already with other plugins, like [CtrlP][]. -If the current file you're editing is found to be in such a project, Autotags +If the current file you're editing is found to be in such a project, Gutentags will make sure the tag file for that project is up to date. Then, as you work in files in that project, it will partially re-generate the tag file. Every time you save, it will silently, in the background, update the tags for that file. -Usually, ctags can only append tags to an existing tag file, so Autotags +Usually, ctags can only append tags to an existing tag file, so Gutentags removes the tags for the current file first, to make sure the tag file is always consistent with the source code. -Also, Autotags is clever enough to not stumble upon itself by triggering +Also, Gutentags is clever enough to not stumble upon itself by triggering multiple ctags processes if you save files to fast, or your project is really big. @@ -46,7 +46,7 @@ There are some similar Vim plugins out there ("vim-tags", "vim-autotag", "vim-automatic-ctags", etc.). They all fail on one or more of the requirements -I set for myself with Autotags: +I set for myself with Gutentags: * No other dependency than running Vim: no Python, Ruby, or whatever. * Cross-platform: should work on at least Mac and Windows. @@ -61,7 +61,7 @@ project, it should start indexing it automatically, just like in Sublime Text or Visual Studio or any other IDE. -I hope Autotags will bring you as much closure as me regarding tag files. I know +I hope Gutentags will bring you as much closure as me regarding tag files. I know I don't want to have to think about it, and probably neither do you.