Skip to content

Commit 1b95766

Browse files
committed
README: Provide info about changes w.r.t. original plugin
And do some tidying up while at it. Signed-off-by: Sam Protsenko <[email protected]>
1 parent 5e180ff commit 1b95766

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

+18-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# cscope-maps
22

33
Just old good cscope maps plugin for vim, taken from [1]. Made a mirror just to
4-
use it in unified way with vim package manager.
4+
use it in unified way with vim package manager. This repository has some
5+
extra improvements on top of original plugin.
56

67
## Description
78

@@ -12,17 +13,31 @@ These key maps use multiple keystrokes (2 or 3 keys). If you find that vim keeps
1213
timing you out before you can complete them, try changing your timeout settings
1314
in plugin file.
1415

16+
For more details please refer to [2].
17+
18+
## Changes
19+
20+
Next changes are made in this repository comparing to original plugin:
21+
22+
* Add key binding to search for C structure (Ctrl-S), in case the structure is
23+
defined using K&R style, e.g.: `struct abc {`
24+
* Use Ctrl-Space key binding to split vertically (as opposed to horizontal
25+
split in original plugin). To split horizontally, use Ctrl-Space-Space.
26+
* If `cscope.out` file is missing in current directory, try to look for it
27+
in upper directories
28+
* Fix some typos
29+
1530
## Installation
1631

1732
* __vim 8__: Stick this file in `~/.vim/pack/<dir>/start/cscope/plugin/`
1833
where `<dir>` is any arbitrary name. Lookup Vim8 packages
1934
for more details.
20-
2135
* __vim 6__: Stick this file in your `~/.vim/plugin` directory (or in a
2236
'plugin' directory in some other directory that is in your
2337
'runtimepath'.
24-
2538
* __vim 5__: Stick this file somewhere and 'source cscope.vim' it from
2639
your `~/.vimrc` file (or cut and paste it into your `.vimrc`).
2740

2841
[1] http://cscope.sourceforge.net/cscope_maps.vim
42+
43+
[2] http://cscope.sourceforge.net/cscope_vim_tutorial.html

0 commit comments

Comments
 (0)