Skip to content

Commit

Permalink
Document vim-misc as external dependency
Browse files Browse the repository at this point in the history
  • Loading branch information
xolox committed May 25, 2013
1 parent 49346b1 commit f97fc05
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 24 deletions.
14 changes: 12 additions & 2 deletions INSTALL.md
@@ -1,3 +1,13 @@
If you're looking for the simplest way to get the plug-in up and running, download [the latest ZIP archive](http://peterodding.com/code/vim/downloads/session.zip) from [Vim Online](http://www.vim.org/scripts/script.php?script_id=3150), unzip that in `~/.vim/` (on UNIX) or `%USERPROFILE%\vimfiles` (on Windows) and you're good to go.
*Please note that the vim-session plug-in requires my vim-misc plug-in which is separately distributed.*

If you're using git and/or [Pathogen](http://www.vim.org/scripts/script.php?script_id=2332), [Vundle](https://github.com/gmarik/vundle) or a similar plug-in manager and want to keep the plug-in up to date using git, you can use the GitHub repository directly, it should just work.
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.


[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
14 changes: 13 additions & 1 deletion README.md
Expand Up @@ -22,7 +22,13 @@ If you're still getting to know the plug-in, the "Sessions" menu may help: It co

## Installation

Unzip the most recent [ZIP archive](http://peterodding.com/code/vim/downloads/session.zip) file 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). After you restart Vim the following commands will be available to you:
*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:

## Commands

Expand Down Expand Up @@ -333,8 +339,14 @@ Here's an example session script generated by the vim-session plug-in while I wa


[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
59 changes: 38 additions & 21 deletions doc/session.txt
Expand Up @@ -87,11 +87,23 @@ contains menu items for most commands defined by the plug-in.
*session-installation*
Installation ~

Unzip the most recent ZIP archive [4] file 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). After you restart Vim the following
commands will be available to you:
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:

===============================================================================
*session-commands*
Expand Down Expand Up @@ -147,7 +159,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 [5].
which can't be easily/safely reloaded using a more lightweight approach [10].
It should work fine on Windows and UNIX alike but because of technical
limitations it only works in graphical Vim.

Expand Down Expand Up @@ -420,12 +432,12 @@ 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 such plug-ins:

- BufExplorer [6], Conque Shell [7], NERD tree [8] and Project [9] windows are
supported;
- BufExplorer [11], Conque Shell [12], NERD tree [13] and Project [14] windows
are supported;

- When shell.vim [10] is installed Vim's full-screen state is persisted;
- When shell.vim [15] is installed Vim's full-screen state is persisted;

- The netrw (see |netrw-start|) and taglist.vim [11] plug-ins support sessions
- The netrw (see |netrw-start|) and taglist.vim [16] plug-ins support sessions
out of the box.

If your favorite plug-in doesn't work with the vim-session plug-in drop me a
Expand All @@ -451,13 +463,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 [12].
If you like the script please vote for it on Vim Online [17].

===============================================================================
*session-license*
License ~

This software is licensed under the MIT license [13]. Copyright 2013 Peter
This software is licensed under the MIT license [18]. Copyright 2013 Peter
Odding <peter@peterodding.com>.

===============================================================================
Expand Down Expand Up @@ -568,14 +580,19 @@ References ~
[2] http://peterodding.com/code/vim/session/autoopen.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/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://peterodding.com/code/vim/shell/
[11] http://www.vim.org/scripts/script.php?script_id=273
[12] http://www.vim.org/scripts/script.php?script_id=3150
[13] http://en.wikipedia.org/wiki/MIT_License
[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://peterodding.com/code/vim/shell/
[16] http://www.vim.org/scripts/script.php?script_id=273
[17] http://www.vim.org/scripts/script.php?script_id=3150
[18] http://en.wikipedia.org/wiki/MIT_License

vim: ft=help

0 comments on commit f97fc05

Please sign in to comment.