First release

1 files changed, 49 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e3eedcf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,49 @@
+# karlmarks
+
+A teaching plugin for Vim. It uses the `signcolumn` to display currently active
+`marks`. These are mostly used as jump locations and some are set by Vim
+automatically during the edit sessions. Also user defined marks are shown.
+These can be set with `m[a-z]`, e.g. `ma` sets mark `a` and this plugin would
+display its line and you can jump to that line with ```a``. Captital letters
+even allow jumps between files and session persistent marks.
+
+Chances are that you have learned only some of the marks Vim has to offer. This
+plugin will remember you to use more and once you have that on disk you can
+always deinstall it again.
+
+
+## Prerequirements
+
+I recommend you use this in your `~/.vim/vimrc`
+
+    set signcolumn=yes
+
+because if you set it to `signcolumn=auto` it will flicker when you change
+the window.
+
+
+## Installation
+
+Download the [zip file](https://git.entwicklerseite.de/vim-recently-used/snapshot/vim-recently-used-master.zip)
+and extract it inside `~/.vim/pack/coderonline/start/`.
+
+### Example
+
+    mkdir ~/.vim/pack/coderonline/start/
+    cd    ~/.vim/pack/coderonline/start/
+    # download plugin in that directory:
+    curl -o vim-recently-used.zip  https://git.entwicklerseite.de/vim-recently-used/snapshot/vim-recently-used-master.zip
+    # unzip the zip file    
+    unzip vim-recently-used.zip
+    # remove zip file (not needed any more)
+    rm vim-recently-used.zip
+
+
+## Deinstallation
+
+Remove the folder `~/.vim/pack/coderonline/start/vim-karlmarks` (if you named
+it as suggested in the Installation section)
+
+### Exmaple
+    rm -irv ~/.vim/pack/coderonline/start/vim-karlmarks
+