Skip to content

Commit

Permalink
Updated README with installation methods.
Browse files Browse the repository at this point in the history
  • Loading branch information
romainl committed Apr 19, 2014
1 parent 816e147 commit 6d6f552
Showing 1 changed file with 48 additions and 3 deletions.
51 changes: 48 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,19 +69,64 @@ Put this line in `~/.screenrc`:

A colorscheme must be placed in a directory named `colors` that’s somewhere in Vim’s `runtimepath`:

The canonical location is:

~/.vim/colors/apprentice.vim

but it could be:

~/.vim/bundle/apprentice/colors/apprentice.vim

How it ends up there is for you to decide.
or whatever works for you.

Here are the most common installation methods:

### Manually:

1. Download [the latest release](https://github.com/romainl/Apprentice/releases/latest).
2. Unzip it somewhere on your machine.
3. Copy the file `colors/apprentice.vim` to `~/.vim/colors/apprentice.vim`.

### With [Pathogen](https://github.com/tpope/vim-pathogen):

#### The grumpy way:

1. Download [the latest release](https://github.com/romainl/Apprentice/releases/latest).
2. Unzip it under `~/.vim/bundle/`.

#### The hipster way:

$ git clone https://github.com/romainl/Apprentice.git ~/.vim/bundle/apprentice

### With [Vundle](https://github.com/gmarik/Vundle.vim):

1. Add this line to your `~/.vimrc`, together with the rest of your `Plugin` lines:

Plugin 'romainl/Apprentice'

2. Run this command to finish the installation:

:PluginInstall

### With [NeoBundle](https://github.com/Shougo/neobundle.vim):

1. Add this line to your `~/.vimrc`, together with the rest of your `NeoBundle` lines:

NeoBundle 'romainl/Apprentice'

2. Run this command to finish the installation:

:NeoBundleInstall

Hmmm… I wonder where does that strange feeling of déjà-vu comes from?

## Enabling Apprentice.

To test Apprentice, just type this command from *normal* mode and hit `Enter`:

:colorscheme apprentice

If you like what you see and want to make Apprentice your default colorscheme, add this line to your `~/.vimrc`:
If you like what you see and want to make Apprentice your default colorscheme, add this line to your `~/.vimrc`, preferably near the end:

colorscheme apprentice

Expand Down

0 comments on commit 6d6f552

Please sign in to comment.