Update installation instructions

Author: xolox

INSTALL.md

@@ -1,13 +1,15 @@
+# Installation instructions
+
 *Please note that the vim-notes plug-in requires my vim-misc plug-in which is separately distributed.*
 
-Unzip the most recent ZIP archives of the [vim-notes] [download-notes] and [vim-misc] [download-misc] plug-ins inside your Vim profile directory (usually this is `~/.vim` on UNIX and `%USERPROFILE%\vimfiles` on Windows), restart Vim and execute the command `:helptags ~/.vim/doc` (use `:helptags ~\vimfiles\doc` instead on Windows).
+There are two ways to install the vim-notes plug-in and it's up to you which you prefer, both options are explained below. Please note that below are generic installation instructions while some Vim plug-ins may have external dependencies, please refer to the plug-in's [readme](README.md) for details.
+
+## Installation using ZIP archives
+
+Unzip the most recent ZIP archives of the [vim-notes](http://peterodding.com/code/vim/downloads/notes.zip) and [vim-misc](http://peterodding.com/code/vim/downloads/misc.zip) plug-ins inside your Vim profile directory (usually this is `~/.vim` on UNIX and `%USERPROFILE%\vimfiles` on Windows), restart Vim and execute the command `:helptags ~/.vim/doc` (use `:helptags ~\vimfiles\doc` instead on Windows).
 
-If you prefer you can also use [Pathogen] [pathogen], [Vundle] [vundle] or a similar tool to install & update the [vim-notes] [github-notes] and [vim-misc] [github-misc] plug-ins using a local clone of the git repository.
+If you get warnings about overwriting existing files while unpacking the ZIP archives you probably don't need to worry about this because it's most likely caused by files like `README.md`, `INSTALL.md` and `addon-info.json`. If these files bother you then you can remove them after unpacking the ZIP archives, they are not required to use the plug-in.
 
+## Installation using a Vim plug-in manager
 
-[download-misc]: http://peterodding.com/code/vim/downloads/misc.zip
-[download-notes]: http://peterodding.com/code/vim/downloads/notes.zip
-[github-misc]: http://github.com/xolox/vim-misc
-[github-notes]: http://github.com/xolox/vim-notes
-[pathogen]: http://www.vim.org/scripts/script.php?script_id=2332
-[vundle]: https://github.com/gmarik/vundle
+If you prefer you can also use [Pathogen](http://www.vim.org/scripts/script.php?script_id=2332), [Vundle](https://github.com/gmarik/vundle) or a similar tool to install and update the [vim-notes](https://github.com/xolox/vim-notes) and [vim-misc](https://github.com/xolox/vim-misc) plug-ins using local clones of the git repositories. This takes a bit of work to set up the first time but it makes updating much easier, and it keeps each plug-in in its own directory which helps to keep your Vim profile uncluttered.

README.md

@@ -26,11 +26,7 @@ Here's a screen shot of the syntax mode (using the [Slate] [slate] color scheme
 
 ## Install & usage
 
-*Please note that the vim-notes plug-in requires my vim-misc plug-in which is separately distributed.*
-
-Unzip the most recent ZIP archives of the [vim-notes] [download-notes] and [vim-misc] [download-misc] plug-ins inside your Vim profile directory (usually this is `~/.vim` on UNIX and `%USERPROFILE%\vimfiles` on Windows), restart Vim and execute the command `:helptags ~/.vim/doc` (use `:helptags ~\vimfiles\doc` instead on Windows). To get started execute `:Note` or `:edit note:`, this will start a new note that contains instructions on how to continue from there (and how to use the plug-in in general).
-
-If you prefer you can also use [Pathogen] [pathogen], [Vundle] [vundle] or a similar tool to install & update the [vim-notes] [github-notes] and [vim-misc] [github-misc] plug-ins using a local clone of the git repository.
+Please refer to [the installation instructions] [install-notes] available on GitHub. Once you've installed the plug-in you can get started by executing `:Note` or `:edit note:`, this will start a new note that contains instructions on how to continue from there (and how to use the plug-in in general).
 
 ## Options
 
@@ -380,23 +376,20 @@ If you have questions, bug reports, suggestions, etc. the author can be contacte
 
 ## License
 
-This software is licensed under the [MIT license] [mit].
+This software is licensed under the [MIT license] [mit].  
 © 2015 Peter Odding &lt;<[email protected]>&gt;.
 
 
 [ctrlwf]: http://vimdoc.sourceforge.net/htmldoc/windows.html#CTRL-W_f
 [ctrlwgf]: http://vimdoc.sourceforge.net/htmldoc/windows.html#CTRL-W_gf
-[download-misc]: http://peterodding.com/code/vim/downloads/misc.zip
-[download-notes]: http://peterodding.com/code/vim/downloads/notes.zip
 [edit]: http://vimdoc.sourceforge.net/htmldoc/editing.html#:edit
 [enc]: http://vimdoc.sourceforge.net/htmldoc/options.html#'encoding'
 [folding]: https://raw.githubusercontent.com/xolox/vim-notes/master/screenshots/folding.png
 [geshi]: http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi
 [gf]: http://vimdoc.sourceforge.net/htmldoc/editing.html#gf
 [gfm]: https://help.github.com/articles/github-flavored-markdown/
-[github-misc]: http://github.com/xolox/vim-misc
-[github-notes]: http://github.com/xolox/vim-notes
 [highlight]: http://vimdoc.sourceforge.net/htmldoc/syntax.html#:highlight
+[install-notes]: https://github.com/xolox/vim-notes/blob/master/INSTALL.md
 [issue_85]: https://github.com/xolox/vim-session/issues/85
 [levenshtein]: http://en.wikipedia.org/wiki/Levenshtein_distance
 [mapleader]: http://vimdoc.sourceforge.net/htmldoc/map.html#mapleader
@@ -419,5 +412,4 @@ This software is licensed under the [MIT license] [mit].
 [vimgrep]: http://vimdoc.sourceforge.net/htmldoc/quickfix.html#:vimgrep
 [vimrc]: http://vimdoc.sourceforge.net/htmldoc/starting.html#vimrc
 [voom]: http://www.vim.org/scripts/script.php?script_id=2657
-[vundle]: https://github.com/gmarik/vundle
 [write]: http://vimdoc.sourceforge.net/htmldoc/editing.html#:write

doc/notes.txt

@@ -141,20 +141,10 @@ the Monaco [7] font):
                                                           *notes-install-usage*
 Install & usage ~
 
-_Please note that the vim-notes plug-in requires my vim-misc plug-in which is
-separately distributed._
-
-Unzip the most recent ZIP archives of the vim-notes [9] and vim-misc [10] plug-
-ins inside your Vim profile directory (usually this is '~/.vim' on UNIX and
-'%USERPROFILE%\vimfiles' on Windows), restart Vim and execute the command
-':helptags ~/.vim/doc' (use ':helptags ~\vimfiles\doc' instead on Windows). To
-get started execute |:Note| or ':edit note:', this will start a new note that
-contains instructions on how to continue from there (and how to use the plug-in
-in general).
-
-If you prefer you can also use Pathogen [11], Vundle [12] or a similar tool to
-install & update the vim-notes [13] and vim-misc [14] plug-ins using a local
-clone of the git repository.
+Please refer to the installation instructions [9] available on GitHub. Once
+you've installed the plug-in you can get started by executing |:Note| or ':edit
+note:', this will start a new note that contains instructions on how to
+continue from there (and how to use the plug-in in general).
 
 ===============================================================================
                                                                 *notes-options*
@@ -180,7 +170,7 @@ circumstances but should work for most people:
 
 - If the profile directory where the plug-in is installed is writable, the
   directory 'misc/notes/user' under the profile directory is used. This is
-  for compatibility with Pathogen [11]; the notes will be stored inside the
+  for compatibility with Pathogen [10]; the notes will be stored inside the
   plug-in's bundle.
 
 - If the above doesn't work out, the default depends on the platform:
@@ -607,7 +597,7 @@ optimized for speed (yet).
 -------------------------------------------------------------------------------
 The *:NoteToMediawiki* command
 
-Convert the current note to a Mediawiki document [15]. This is similar to the
+Convert the current note to a Mediawiki document [11]. This is similar to the
 |:NoteToMarkdown| command, but it produces wiki text that can be displayed on a
 Mediawiki site. That being said, the subset of wiki markup that vim-notes
 actually produces will probably work on other wiki sites. These are the notable
@@ -620,7 +610,7 @@ transforations:
 
 - Preformatted blocks are output into '<syntaxhighlight lang="..">' tags.
   This functionality is enabled on Mediawiki through the SyntaxHighlight
-  GeSHi extention [16]. It is also supported on Wikipedia.
+  GeSHi extention [12]. It is also supported on Wikipedia.
 
 ===============================================================================
                                                                *notes-mappings*
@@ -709,14 +699,14 @@ Other plug-ins that work well with the notes plug-in ~
                                                                 *notes-utl.vim*
 utl.vim ~
 
-The utl.vim [17] universal text linking plug-in enables links between your
+The utl.vim [13] universal text linking plug-in enables links between your
 notes, other local files and remote resources like web pages.
 
 -------------------------------------------------------------------------------
                                                               *notes-shell.vim*
 shell.vim ~
 
-My shell.vim [18] plug-in also enables easy navigation between your notes and
+My shell.vim [14] plug-in also enables easy navigation between your notes and
 environment like local files and directories, web pages and e-mail addresses by
 providing key mappings and commands to e.g. open the file/URL under the text
 cursor. This plug-in can also change Vim to full screen which can be really
@@ -726,7 +716,7 @@ nice for large notes.
                                                                    *notes-voom*
 VOoM ~
 
-The VOoM [19] outlining plug-in should work well for notes if you use the
+The VOoM [15] outlining plug-in should work well for notes if you use the
 Markdown style headers starting with '#', however it has been reported that
 this combination may not always work so well in practice (sometimes losing
 notes!)
@@ -736,7 +726,7 @@ notes!)
 Txtfmt ~
 
 If the text formatting supported by the notes plug-in is not enough for you,
-consider trying the Txtfmt [20] (The Vim Highlighter) plug-in. To use the two
+consider trying the Txtfmt [16] (The Vim Highlighter) plug-in. To use the two
 plug-ins together, create the file 'after/ftplugin/notes.vim' inside your Vim
 profile with the following contents:
 >
@@ -752,7 +742,7 @@ absolute pathnames that most certainly won't match between e.g. Windows and
 Linux or even Windows and Cygwin. The best you can do is keep separate session
 scripts for different platforms (and I would certainly consider Cygwin a
 separate platform altogether :-). For more information please refer to issue
-#85 [21].
+#85 [17].
 
 ===============================================================================
                                                                 *notes-contact*
@@ -761,13 +751,13 @@ Contact ~
 If you have questions, bug reports, suggestions, etc. the author can be
 contacted at [email protected]. The latest version is available at
 http://peterodding.com/code/vim/notes/ and http://github.com/xolox/vim-notes.
-If you like the script please vote for it on Vim Online [22].
+If you like the script please vote for it on Vim Online [18].
 
 ===============================================================================
                                                                 *notes-license*
 License ~
 
-This software is licensed under the MIT license [23]. © 2015 Peter Odding
+This software is licensed under the MIT license [19]. © 2015 Peter Odding
 <[email protected]>.
 
 ===============================================================================
@@ -782,20 +772,16 @@ References ~
 [6] http://code.google.com/p/vim/source/browse/runtime/colors/slate.vim
 [7] http://en.wikipedia.org/wiki/Monaco_(typeface)
 [8] http://peterodding.com/code/vim/notes/syntax.png
-[9] http://peterodding.com/code/vim/downloads/notes.zip
-[10] http://peterodding.com/code/vim/downloads/misc.zip
-[11] http://www.vim.org/scripts/script.php?script_id=2332
-[12] https://github.com/gmarik/vundle
-[13] http://github.com/xolox/vim-notes
-[14] http://github.com/xolox/vim-misc
-[15] https://www.mediawiki.org/wiki/MediaWiki
-[16] http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi
-[17] http://www.vim.org/scripts/script.php?script_id=293
-[18] http://www.vim.org/scripts/script.php?script_id=3123
-[19] http://www.vim.org/scripts/script.php?script_id=2657
-[20] http://www.vim.org/scripts/script.php?script_id=2208
-[21] https://github.com/xolox/vim-session/issues/85
-[22] http://www.vim.org/scripts/script.php?script_id=3375
-[23] http://en.wikipedia.org/wiki/MIT_License
+[9] https://github.com/xolox/vim-notes/blob/master/INSTALL.md
+[10] http://www.vim.org/scripts/script.php?script_id=2332
+[11] https://www.mediawiki.org/wiki/MediaWiki
+[12] http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi
+[13] http://www.vim.org/scripts/script.php?script_id=293
+[14] http://www.vim.org/scripts/script.php?script_id=3123
+[15] http://www.vim.org/scripts/script.php?script_id=2657
+[16] http://www.vim.org/scripts/script.php?script_id=2208
+[17] https://github.com/xolox/vim-session/issues/85
+[18] http://www.vim.org/scripts/script.php?script_id=3375
+[19] http://en.wikipedia.org/wiki/MIT_License
 
 vim: ft=help