Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Documentation updates #33

Open
wants to merge 3 commits into from

1 participant

@smokey42

I added installation instructions when using Vundle (tested by me, works) and fixed a few typos.

smokey42 added some commits
@smokey42 smokey42 [vim] Documentation
 * Add Vundle installation instructions
7e27208
@smokey42 smokey42 [vim] Documentation
 * Fix table formatting
14c4ece
@smokey42 smokey42 [vim] Documentation
 * Fix typo
8ccc5fb
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Oct 13, 2011
  1. @smokey42

    [vim] Documentation

    smokey42 authored
     * Add Vundle installation instructions
  2. @smokey42

    [vim] Documentation

    smokey42 authored
     * Fix table formatting
  3. @smokey42

    [vim] Documentation

    smokey42 authored
     * Fix typo
This page is out of date. Refresh to see the latest.
Showing with 78 additions and 7 deletions.
  1. +27 −3 README.mkd
  2. +26 −1 colors/solarized.vim
  3. +25 −3 doc/solarized.txt
View
30 README.mkd
@@ -73,9 +73,33 @@ Installation
$ mv vim-colors-solarized ~/.vim/bundle/
+### Option 3: Installation with Vundle
+
+1. Download and install gmarik's [Vundle]
+
+2. Put the following line into your `.vimrc`, but make sure it's after the
+ Vundle initialisation section.
+
+ Bundle 'altercation/vim-colors-solarized'
+
+3. Now we only need to instruct Vundle to install the newly referenced Bundle.
+ The `BundleInstall` command will directly install Solarized from it's GitHub
+ repository into your `~/.vim/bundle` directory.
+
+ Here is how you do it:
+
+ a. **From the command line:**
+
+ vim -c BundleInstall -c qa
+
+ b. **From within vim itself:**
+
+ :BundleInstall
+
+
### Modify .vimrc
-After either Option 1 or Option 2 above, put the following two lines in your
+After either Option 1, Option 2 or Option 3 above, put the following two lines in your
.vimrc:
syntax enable
@@ -118,7 +142,7 @@ If you do use the custom terminal colors, solarized.vim should work out of the
box for you. If you are using a terminal emulator that supports 256 colors and
don't want to use the custom Solarized terminal colors, you will need to use
the degraded 256 colorscheme. To do so, simply add the following line *before*
-the `colorschem solarized` line:
+the `colorscheme solarized` line:
let g:solarized_termcolors=256
@@ -132,7 +156,7 @@ Solarized will work out of the box with just the two lines specified above but
does include several other options that can be set in your .vimrc file.
Set these in your vimrc file prior to calling the colorscheme.
-"
+
option name default optional
------------------------------------------------
g:solarized_termcolors= 16 | 256
View
27 colors/solarized.vim
@@ -27,7 +27,7 @@
" ---------------------------------------------------------------------
" INSTALLATION:
" ---------------------------------------------------------------------
-" Two options for installation: manual or pathogen
+" Two options for installation: manual, vundle or pathogen(recommended)
"
" MANUAL INSTALLATION OPTION:
" ---------------------------------------------------------------------
@@ -39,6 +39,31 @@
" subdirectory (e.g. autoload/togglebg.vim goes into your .vim/autoload
" directory as .vim/autoload/togglebg.vim).
"
+" VUNDLE INSTALLATION OPTION:
+" ---------------------------------------------------------------------
+"
+" 1. Download and install gmarik's Vundle from:
+" https://github.com/gmarik/vundle [Vundle]
+"
+" 2. Put the following line into your `.vimrc`, but make sure it's after the
+" Vundle initialisation section.
+"
+" Bundle 'altercation/vim-colors-solarized'
+"
+" 3. Now we only need to instruct Vundle to install the newly referenced Bundle.
+" The `BundleInstall` command will directly install Solarized from it's GitHub
+" repository into your `~/.vim/bundle` directory.
+"
+" Here is how you do it:
+"
+" a. **From the command line:**
+"
+" vim -c BundleInstall -c qa
+"
+" b. **From within vim itself:**
+"
+" :BundleInstall
+"
" RECOMMENDED PATHOGEN INSTALLATION OPTION:
" ---------------------------------------------------------------------
"
View
28 doc/solarized.txt
@@ -24,6 +24,9 @@ details.
==============================================================================
0. Install *solarized-install*
+
+WITH PATHOGEN
+
Note: I recommend using Tim Pope's pathogen plugin to install this
colorscheme. See https://github.com/tpope/vim-pathogen . If you've installed
pathogen properly you can install Solarized with the following commands,
@@ -32,8 +35,25 @@ followed by the .vimrc configuration below.
$ cd ~/.vim/bundle
$ git clone https://github.com/altercation/vim-colors-solarized.git
-If you aren't using pathogen, you can use the following three steps to install
-Solarized:
+
+WITH VUNDLE
+
+If you are using gmarik's vundle plugin, and assuming you have installed it
+correctly you can use Solarized as a Bundle by putting the following line
+into your `.vimrc`:
+
+ Bundle 'altercation/vim-colors-solarized'
+
+To make Vundle install the Bundle for you, you need to run :BundleInstall
+from within vim or issue the following command:
+
+ $ vim -c BundleInstall -c qa
+
+
+BY HAND
+
+If you aren't using either pathogen or vundle, you can use the following three
+steps to install Solarized:
1. Download the solarized distribution (available on the homepage above)
and unarchive the file.
@@ -45,6 +65,8 @@ Solarized:
directory as .vim/autoload/togglebg.vim).
+IN ANY CASE
+
After installation, place the following lines in your .vimrc:
syntax enable
@@ -121,7 +143,7 @@ If you do use the custom terminal colors, solarized.vim should work out of
the box for you. If you are using a terminal emulator that supports 256
colors and don't want to use the custom Solarized terminal colors, you will
need to use the degraded 256 colorscheme. To do so, simply add the following
-line *before* the `colorschem solarized` line:
+line *before* the `colorscheme solarized` line:
let g:solarized_termcolors=256
Something went wrong with that request. Please try again.