Skip to content

Commit 7cafcb7

Browse files
committed
README: add installation instructions; closes #6
1 parent b43808e commit 7cafcb7

File tree

3 files changed

+55
-1
lines changed

3 files changed

+55
-1
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,23 @@ typing more shortcut keys or parts of shortcut descriptions shown in the menu.
1313

1414
* [fzf.vim] plugin.
1515

16+
## Installation
17+
18+
1. Clone this Git repository as follows, or [download and extract its
19+
contents]( https://github.com/sunaku/vim-shortcut/archive/master.zip ).
20+
21+
git clone https://github.com/sunaku/vim-shortcut.git ~/vim-shortcut
22+
23+
2. Run the following commands in Vim to start using this plugin immediately,
24+
or add them to your *vimrc* file to automate this whenever you start Vim.
25+
26+
:set runtimepath+=~/vim-shortcut
27+
:runtime plugin/shortcut.vim
28+
29+
3. Run the following command inside Vim to learn more about using this plugin.
30+
31+
:help shortcut.vim
32+
1633
## Usage
1734

1835
* Use the `Shortcut!` prefix (with a bang) to describe existing shortcuts.
@@ -130,7 +147,7 @@ Any extra whitespace is ignored.
130147

131148
## Documentation
132149

133-
Run `:help shortcut` or see the `doc/shortcut.txt` file.
150+
Run `:help shortcut.vim` or see the `doc/shortcut.txt` file.
134151

135152
## Testing
136153

doc/shortcut.txt

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,28 @@ to discover what else is available. You can interactively filter the menu by
1717
typing more shortcut keys or parts of shortcut descriptions shown in the menu.
1818

1919

20+
------------------------------------------------------------------------------
21+
INSTALLATION *shortcut-install*
22+
------------------------------------------------------------------------------
23+
24+
1. Clone this plugin's Git repository as follows, or download and extract its
25+
contents from <https://github.com/sunaku/vim-shortcut/archive/master.zip>.
26+
>
27+
git clone https://github.com/sunaku/vim-shortcut.git ~/vim-shortcut
28+
<
29+
30+
2. Run the following commands in Vim to start using this plugin immediately,
31+
or add them to your |vimrc| file to automate this whenever you start Vim.
32+
>
33+
:set runtimepath+=~/vim-shortcut
34+
:runtime plugin/shortcut.vim
35+
<
36+
37+
3. Run the following command inside Vim to learn more about using this plugin.
38+
>
39+
:help shortcut.vim
40+
<
41+
2042
------------------------------------------------------------------------------
2143
USAGE *shortcut-usage*
2244
------------------------------------------------------------------------------

doc/tags

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
:Shortcut shortcut.txt /*:Shortcut*
2+
:Shortcut! shortcut.txt /*:Shortcut!*
3+
:Shortcuts shortcut.txt /*:Shortcuts*
4+
:Shortcuts! shortcut.txt /*:Shortcuts!*
5+
:ShortcutsRangeless shortcut.txt /*:ShortcutsRangeless*
6+
:ShortcutsRangeless! shortcut.txt /*:ShortcutsRangeless!*
7+
g:shortcuts shortcut.txt /*g:shortcuts*
8+
g:shortcuts_overwrite_warning shortcut.txt /*g:shortcuts_overwrite_warning*
9+
shortcut-cmd shortcut.txt /*shortcut-cmd*
10+
shortcut-install shortcut.txt /*shortcut-install*
11+
shortcut-intro shortcut.txt /*shortcut-intro*
12+
shortcut-setup shortcut.txt /*shortcut-setup*
13+
shortcut-usage shortcut.txt /*shortcut-usage*
14+
shortcut-var shortcut.txt /*shortcut-var*
15+
shortcut.vim shortcut.txt /*shortcut.vim*

0 commit comments

Comments
 (0)