Permalink
Browse files

Update README w/ links to slides/cheatsheet/downloads, and add some i…

…nfo about local overrides
  • Loading branch information...
1 parent 510895a commit 25e6fc60c70bfd778b7ac47c03009a9c1e864a77 @tmm1 tmm1 committed Jan 21, 2011
Showing with 23 additions and 5 deletions.
  1. +23 −5 README.markdown
View
@@ -18,6 +18,16 @@ that we have given careful thought to the experience of using MacVIM
with the tools in question. If you run into an issue using it, please
report an issue to the issue tracker.
+## Pre-requisites
+
+Janus is built primarily for [MacVim](http://code.google.com/p/macvim/) on OSX.
+Download it [here](https://github.com/b4winckler/macvim/downloads).
+
+Alternatively, you can use Janus with the bundled console `vim` installation on
+OSX (via Terminal), or with any other vim or gvim installation.
+
+Debian/Ubuntu users can `apt-get install vim-full` for a similar setup.
+
## Installation
0. `for i in ~/.vim ~/.vimrc ~/.gvimrc; do [ -e $i ] && mv $i $i.old;
@@ -30,6 +40,16 @@ or
`curl https://github.com/carlhuda/janus/raw/master/bootstrap.sh -o - | sh`
+## Customization
+
+Create `~/.vimrc.local` and `~/.gvimrc.local` for any local
+customizations.
+
+For example, to override the default color schemes:
+
+ echo color desert > ~/.vimrc.local
+ echo color molokai > ~/.gvimrc.local
+
## Updating to the latest version
To update to the latest version of the distribution, just run `rake`
@@ -39,10 +59,11 @@ again inside your `~/.vim` directory.
Here's some tips if you've never used VIM before:
-## Tutorial
+## Tutorials
* Type `vimtutor` into a shell to go through a brief interactive
tutorial inside VIM.
+* Read the slides at [VIM: Walking Without Crutches](http://walking-without-crutches.heroku.com/#1).
## Modes
@@ -57,6 +78,7 @@ Here's some tips if you've never used VIM before:
* Use `:q` to exit vim
* Certain commands are prefixed with a `<Leader>` key, which maps to `\`
by default. Use `let mapleader = ","` to change this.
+* Keyboard [cheat sheet](http://walking-without-crutches.heroku.com/image/images/vi-vim-cheat-sheet.png).
# Features
@@ -248,7 +270,3 @@ Janus also has a few customized versions of popular themes:
* molokai
* railscasts+
-To permanently set a color scheme, update your local vimrc files:
-
- echo color desert > ~/.vimrc.local
- echo color jellybeans+ > ~/.gvimrc.local

0 comments on commit 25e6fc6

Please sign in to comment.