Update installation instructions

INSTALL.md

@@ -1,13 +1,15 @@
+# Installation instructions
+
 *Please note that the vim-session plug-in requires my vim-misc plug-in which is separately distributed.*
 
-Unzip the most recent ZIP archives of the [vim-session] [download-session] 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).
+There are two ways to install the vim-session 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-session](http://peterodding.com/code/vim/downloads/session.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-session] [github-session] 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-session]: http://peterodding.com/code/vim/downloads/session.zip
-[github-misc]: http://github.com/xolox/vim-misc
-[github-session]: http://github.com/xolox/vim-session
-[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-session](https://github.com/xolox/vim-session) 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

@@ -22,13 +22,7 @@ If you're still getting to know the plug-in, the "Sessions" menu may help: It co
 
 ## Installation
 
-*Please note that the vim-session plug-in requires my vim-misc plug-in which is separately distributed.*
-
-Unzip the most recent ZIP archives of the [vim-session] [download-session] 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-session] [github-session] and [vim-misc] [github-misc] plug-ins using a local clone of the git repository.
-
-After you've installed the plug-in and restarted Vim, the following commands will be available to you:
+Please refer to the [installation instructions] [howto-install] available on GitHub. Once you've installed the plug-in the commands below will be available to you.
 
 ## Commands
 
@@ -271,7 +265,7 @@ Recently this plug-in switched from reimplementing [:mksession][mksession] to ac
 <!-- Start of generated documentation -->
 
 The documentation of the 39 functions below was extracted from
-2 Vim scripts on March 15, 2015 at 17:23.
+2 Vim scripts on April  1, 2015 at 22:22.
 
 ### Public API for the vim-session plug-in
 
@@ -621,14 +615,9 @@ Here's an example session script generated by the vim-session plug-in while I wa
 
 [bg]: http://vimdoc.sourceforge.net/htmldoc/options.html#'background'
 [delcommand]: http://vimdoc.sourceforge.net/htmldoc/map.html#:delcommand
-[download-misc]: http://peterodding.com/code/vim/downloads/misc.zip
-[download-session]: http://peterodding.com/code/vim/downloads/session.zip
-[github-misc]: http://github.com/xolox/vim-misc
-[github-session]: http://github.com/xolox/vim-session
 [mksession]: http://vimdoc.sourceforge.net/htmldoc/starting.html#:mksession
-[pathogen]: http://www.vim.org/scripts/script.php?script_id=2332
 [sessionoptions]: http://vimdoc.sourceforge.net/htmldoc/options.html#%27sessionoptions%27
 [source]: http://vimdoc.sourceforge.net/htmldoc/repeat.html#:source
 [tabnew]: http://vimdoc.sourceforge.net/htmldoc/tabpage.html#:tabnew
 [vimrc]: http://vimdoc.sourceforge.net/htmldoc/starting.html#vimrc
-[vundle]: https://github.com/gmarik/vundle
+[howto-install]: https://github.com/xolox/vim-session/blob/master/INSTALL.md

doc/session.txt

@@ -124,23 +124,8 @@ contains menu items for most commands defined by the plug-in.
                                                          *session-installation*
 Installation ~
 
-_Please note that the vim-session plug-in requires my vim-misc plug-in which is
-separately distributed._
-
-Unzip the most recent ZIP archives of the vim-session [4] and vim-misc [5]
-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 [6], Vundle [7] or a similar tool to
-install & update the vim-session [8] and vim-misc [9] plug-ins using a local
-clone of the git repository.
-
-After you've installed the plug-in and restarted Vim, the following commands
-will be available to you:
+Please refer to the installation instructions [4] available on GitHub. Once
+you've installed the plug-in the commands below will be available to you.
 
 ===============================================================================
                                                              *session-commands*
@@ -196,7 +181,7 @@ The *:RestartVim* command
 
 This command saves your current editing session, restarts Vim and restores your
 editing session. This can come in handy when you're debugging Vim scripts which
-can't be easily/safely reloaded using a more lightweight approach [10]. It
+can't be easily/safely reloaded using a more lightweight approach [5]. It
 should work fine on Windows and UNIX alike but because of technical limitations
 it only works in graphical Vim.
 
@@ -518,9 +503,9 @@ Vim's |:mksession| command isn't really compatible with plug-ins that create
 buffers with generated content and because of this the vim-session plug-in
 includes specific workarounds for a couple of popular plug-ins:
 
-- BufExplorer [11], Conque Shell [12], NERD tree [13], Project [14] and
-  taglist [15] windows are supported;
-- When shell.vim [16] is installed Vim's full-screen state is persisted;
+- BufExplorer [6], Conque Shell [7], NERD tree [8], Project [9] and taglist
+  [10] windows are supported;
+- When shell.vim [11] is installed Vim's full-screen state is persisted;
 - The netrw (see |netrw-start|) plug-in supports sessions out of the box.
 
 If your favorite plug-in doesn't work with the vim-session plug-in drop me a
@@ -544,7 +529,7 @@ might take a while...)
 Function reference ~
 
 The documentation of the 39 functions below was extracted from 2 Vim scripts on
-March 15, 2015 at 17:23.
+April 1, 2015 at 22:22.
 
 -------------------------------------------------------------------------------
                                            *public-api-for-vim-session-plug-in*
@@ -596,7 +581,7 @@ session script.
 The *xolox#session#save_fullscreen()* function
 
 Save the full screen state of Vim. This function provides integration between
-my vim-session [17] and vim-shell [18] plug-ins. The first argument is expected
+my vim-session [12] and vim-shell [13] plug-ins. The first argument is expected
 to be a list, it will be extended with the lines to be added to the session
 script.
 
@@ -636,7 +621,7 @@ Check that the user has started Vim without editing any files. Used by
 should be performed. Currently checks the following conditions:
 
 1. That the current buffer is either empty (contains no lines and is not
-   modified) or showing vim-startify [19].
+   modified) or showing vim-startify [14].
 2. That the buffer list either empty or persistent.
 
 -------------------------------------------------------------------------------
@@ -797,13 +782,13 @@ Contact ~
 If you have questions, bug reports, suggestions, etc. the author can be
 contacted at peter@peterodding.com. The latest version is available at
 http://peterodding.com/code/vim/session/ and http://github.com/xolox/vim-
-session. If you like the script please vote for it on Vim Online [20].
+session. If you like the script please vote for it on Vim Online [15].
 
 ===============================================================================
                                                               *session-license*
 License ~
 
-This software is licensed under the MIT license [21]. © 2015 Peter Odding
+This software is licensed under the MIT license [16]. © 2015 Peter Odding
 <peter@peterodding.com> and Ingo Karkat.
 
 Thanks go out to everyone who has helped to improve the vim-session plug-in
@@ -916,23 +901,18 @@ References ~
 [1] https://raw.githubusercontent.com/xolox/vim-session/master/screenshots/session-save-prompt.png
 [2] https://raw.githubusercontent.com/xolox/vim-session/master/screenshots/session-restore-prompt.png
 [3] http://peterodding.com/code/vim/session/#sample_session_script
-[4] http://peterodding.com/code/vim/downloads/session.zip
-[5] http://peterodding.com/code/vim/downloads/misc.zip
-[6] http://www.vim.org/scripts/script.php?script_id=2332
-[7] https://github.com/gmarik/vundle
-[8] http://github.com/xolox/vim-session
-[9] http://github.com/xolox/vim-misc
-[10] http://peterodding.com/code/vim/reload/
-[11] http://www.vim.org/scripts/script.php?script_id=42
-[12] http://www.vim.org/scripts/script.php?script_id=2771
-[13] http://www.vim.org/scripts/script.php?script_id=1658
-[14] http://www.vim.org/scripts/script.php?script_id=69
-[15] http://www.vim.org/scripts/script.php?script_id=273
-[16] http://peterodding.com/code/vim/shell/
-[17] http://peterodding.com/code/vim/session
-[18] http://peterodding.com/code/vim/shell
-[19] https://github.com/mhinz/vim-startify/
-[20] http://www.vim.org/scripts/script.php?script_id=3150
-[21] http://en.wikipedia.org/wiki/MIT_License
+[4] https://github.com/xolox/vim-session/blob/master/INSTALL.md
+[5] http://peterodding.com/code/vim/reload/
+[6] http://www.vim.org/scripts/script.php?script_id=42
+[7] http://www.vim.org/scripts/script.php?script_id=2771
+[8] http://www.vim.org/scripts/script.php?script_id=1658
+[9] http://www.vim.org/scripts/script.php?script_id=69
+[10] http://www.vim.org/scripts/script.php?script_id=273
+[11] http://peterodding.com/code/vim/shell/
+[12] http://peterodding.com/code/vim/session
+[13] http://peterodding.com/code/vim/shell
+[14] https://github.com/mhinz/vim-startify/
+[15] http://www.vim.org/scripts/script.php?script_id=3150
+[16] http://en.wikipedia.org/wiki/MIT_License
 
 vim: ft=help