Mercurial > vim-gutentags

comparison README.md @ 172:02a94ff0db57

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add CONTRIBUTING file.
author Ludovic Chabant <ludovic@chabant.com>
date Sun, 19 Feb 2017 20:47:50 -0800
parents 586c3a86adac
children bd641fccdae4
comparison
equal deleted inserted replaced
171:18df731b1563 172:02a94ff0db57
3 3
4 Gutentags is a plugin that takes care of the much needed management of tags 4 Gutentags is a plugin that takes care of the much needed management of tags
5 files in Vim. It will (re)generate tag files as you work while staying 5 files in Vim. It will (re)generate tag files as you work while staying
6 completely out of your way. It will even do its best to keep those tag files 6 completely out of your way. It will even do its best to keep those tag files
7 out of your way too. It has no dependencies and just works. 7 out of your way too. It has no dependencies and just works.
8
8 9
9 ## How? 10 ## How?
10 11
11 Install Gutentags like any other Vim plugin. I recommend something like 12 Install Gutentags like any other Vim plugin. I recommend something like
12 [Pathogen][], so you can go: 13 [Pathogen][], so you can go:
47 There are some similar Vim plugins out there ("vim-tags", "vim-autotag", 48 There are some similar Vim plugins out there ("vim-tags", "vim-autotag",
48 "vim-automatic-ctags", etc.). They all fail on one or more of the requirements 49 "vim-automatic-ctags", etc.). They all fail on one or more of the requirements
49 I set for myself with Gutentags: 50 I set for myself with Gutentags:
50 51
51 * No other dependency than running Vim: no Python, Ruby, or whatever. 52 * No other dependency than running Vim: no Python, Ruby, or whatever.
52 * Cross-platform: should work on at least Mac and Windows. 53 * Cross-platform: should work on at least Ubuntu, Mac, and Windows.
53 * Incremental tags generation: don't re-generate the whole project all the time. 54 * Incremental tags generation: don't re-generate the whole project all the time.
54 This may be fine for small projects, but it doesn't scale. 55 This may be fine for small projects, but it doesn't scale.
55 * External process management: if the ctags process is taking a long time, don't 56 * External process management: if the ctags process is taking a long time, don't
56 run another one because I saved the file again. 57 run another one because I saved a file again.
57 * Keep the tag file consistent: don't just append the current file's tags to the 58 * Keep the tag file consistent: don't just append the current file's tags to the
58 tag file, otherwise you will still "see" tags for deleted or renamed classes 59 tag file, otherwise you will still "see" tags for deleted or renamed classes
59 and functions. 60 and functions.
60 * Automatically create the tag file: you open something from a freshly forked 61 * Automatically create the tag file: you open something from a freshly forked
61 project, it should start indexing it automatically, just like in Sublime Text 62 project, it should start indexing it automatically, just like in Sublime Text