Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Document vim-misc as external dependency (needs to be installed separ…

…ately from now on)
  • Loading branch information...
commit afeefedf3d4108d875253a677f61a8d98bbc1f56 1 parent 460e9ea
@xolox authored
View
16 INSTALL.md
@@ -1,3 +1,15 @@
-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/colorscheme-switcher.zip) from [Vim Online](http://www.vim.org/scripts/script.php?script_id=4586), unzip that in `~/.vim/` (on UNIX) or `%USERPROFILE%\vimfiles` (on Windows) and you're good to go.
+*Please note that the vim-colorscheme-switcher 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-colorscheme-switcher] [dcs] and [vim-misc] [dms] 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). Now try it out: Execute `:NextColorScheme` to switch to the next color scheme.
+
+If you didn't change the plug-in's configuration you can now use the `F8` and `Shift-F8` keys to switch to the next/previous color scheme.
+
+If you prefer you can also use [Pathogen] [pathogen], [Vundle] [vundle] or a similar tool to install & update the [vim-colorscheme-switcher] [github-colorscheme-switcher] and [vim-misc] [github-misc] plug-ins using a local clone of the git repository.
+
+
+[dcs]: http://peterodding.com/code/vim/downloads/colorscheme-switcher.zip
+[dms]: http://peterodding.com/code/vim/downloads/misc.zip
+[github-colorscheme-switcher]: http://github.com/xolox/vim-colorscheme-switcher
+[github-misc]: http://github.com/xolox/vim-misc
+[pathogen]: http://www.vim.org/scripts/script.php?script_id=2332
+[vundle]: https://github.com/gmarik/vundle
View
13 README.md
@@ -4,10 +4,14 @@ The colorscheme switcher plug-in for the [Vim text editor] [vim] makes it easy t
## Installation
-Unzip the most recent [ZIP archive] [dl] 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). Now try it out: Execute `:NextColorScheme` to switch to the next color scheme.
+*Please note that the vim-colorscheme-switcher plug-in requires my vim-misc plug-in which is separately distributed.*
+
+Unzip the most recent ZIP archives of the [vim-colorscheme-switcher] [dcs] and [vim-misc] [dms] 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). Now try it out: Execute `:NextColorScheme` to switch to the next color scheme.
If you didn't change the plug-in's configuration you can now use the `F8` and `Shift-F8` keys to switch to the next/previous color scheme.
+If you prefer you can also use [Pathogen] [pathogen], [Vundle] [vundle] or a similar tool to install & update the [vim-colorscheme-switcher] [github-colorscheme-switcher] and [vim-misc] [github-misc] plug-ins using a local clone of the git repository.
+
## Commands
### The `:NextColorScheme` command
@@ -70,9 +74,14 @@ This software is licensed under the [MIT license] [mit].
[bg]: http://vimdoc.sourceforge.net/htmldoc/options.html#'background'
[cs]: http://vimdoc.sourceforge.net/htmldoc/syntax.html#:colorscheme
-[dl]: http://peterodding.com/code/vim/downloads/colorscheme-switcher.zip
+[dcs]: http://peterodding.com/code/vim/downloads/colorscheme-switcher.zip
+[dms]: http://peterodding.com/code/vim/downloads/misc.zip
+[github-colorscheme-switcher]: http://github.com/xolox/vim-colorscheme-switcher
+[github-misc]: http://github.com/xolox/vim-misc
[hi]: http://vimdoc.sourceforge.net/htmldoc/syntax.html#:highlight
[mit]: http://en.wikipedia.org/wiki/MIT_License
+[pathogen]: http://www.vim.org/scripts/script.php?script_id=2332
[vim]: http://www.vim.org/
[vim_online]: http://www.vim.org/scripts/script.php?script_id=4586
[vimrc]: http://vimdoc.sourceforge.net/htmldoc/starting.html#vimrc
+[vundle]: https://github.com/gmarik/vundle
View
4 autoload/xolox/colorscheme_switcher.vim
@@ -1,9 +1,9 @@
" Vim plug-in
" Maintainer: Peter Odding <peter@peterodding.com>
-" Last Change: May 21, 2013
+" Last Change: May 25, 2013
" URL: http://peterodding.com/code/vim/colorscheme-switcher
-let g:xolox#colorscheme_switcher#version = '0.2.3'
+let g:xolox#colorscheme_switcher#version = '0.2.4'
" Dictionary with previously seen links between highlighting groups.
if !exists('s:known_links')
View
41 doc/colorscheme-switcher.txt
@@ -29,15 +29,23 @@ and mappings to switch to the next and previous color schemes.
*colorscheme-switcher-installation*
Installation ~
-Unzip the most recent ZIP archive [1] 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). Now try it out: Execute
-|:NextColorScheme| to switch to the next color scheme.
+Please note that the vim-colorscheme-switcher plug-in requires my vim-misc
+plug-in which is separately distributed.
+
+Unzip the most recent ZIP archives of the vim-colorscheme-switcher [1] and
+vim-misc [2] 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). Now try it out: Execute |:NextColorScheme| to switch to
+the next color scheme.
If you didn't change the plug-in's configuration you can now use the 'F8' and
'Shift-F8' keys to switch to the next/previous color scheme.
+If you prefer you can also use Pathogen [3], Vundle [4] or a similar tool to
+install & update the vim-colorscheme-switcher [5] and vim-misc [6] plug-ins
+using a local clone of the git repository.
+
===============================================================================
*colorscheme-switcher-commands*
Commands ~
@@ -103,9 +111,9 @@ implementation detail of how Vim works internally, in other words I think it's
a bug that should be fixed... Here are some references that explain the
problem in some detail:
- - Vim colorscheme leaves a wake of destruction when switching away [2]
+ - Vim colorscheme leaves a wake of destruction when switching away [7]
- - gVim: remove syntax highlighting groups [3]
+ - gVim: remove syntax highlighting groups [8]
Since this behavior hinders cycling through color schemes, the colorscheme
switcher plug-in includes a workaround that should hide the problem:
@@ -139,23 +147,28 @@ 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/colorscheme-switcher/ and
http://github.com/xolox/vim-colorscheme-switcher. If you like this plug-in
-please vote for it on Vim Online [4].
+please vote for it on Vim Online [9].
===============================================================================
*colorscheme-switcher-license*
License ~
-This software is licensed under the MIT license [5]. Š 2013 Peter Odding
-<peter@peterodding.com>.
+This software is licensed under the MIT license [10]. Copyright 2013 Peter
+Odding <peter@peterodding.com>.
===============================================================================
*colorscheme-switcher-references*
References ~
[1] http://peterodding.com/code/vim/downloads/colorscheme-switcher.zip
-[2] https://github.com/altercation/solarized/issues/102
-[3] http://stackoverflow.com/questions/12915797/gvim-remove-syntax-highlighting-groups
-[4] http://www.vim.org/scripts/script.php?script_id=4586
-[5] http://en.wikipedia.org/wiki/MIT_License
+[2] http://peterodding.com/code/vim/downloads/misc.zip
+[3] http://www.vim.org/scripts/script.php?script_id=2332
+[4] https://github.com/gmarik/vundle
+[5] http://github.com/xolox/vim-colorscheme-switcher
+[6] http://github.com/xolox/vim-misc
+[7] https://github.com/altercation/solarized/issues/102
+[8] http://stackoverflow.com/questions/12915797/gvim-remove-syntax-highlighting-groups
+[9] http://www.vim.org/scripts/script.php?script_id=4586
+[10] http://en.wikipedia.org/wiki/MIT_License
vim: ft=help
Please sign in to comment.
Something went wrong with that request. Please try again.