Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Rewrite the install to include the pathogen install steps #336

Merged
merged 2 commits into from

2 participants

@zedshaw

Currently your docs assume a lot about the vim user's prior knowledge. This rewrite just puts all the steps needed in one spot and then explains potential pitfalls and how to fix them.

@scrooloose scrooloose merged commit a1ae9f1 into from
@scrooloose
Owner

Sweet, cheers :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
This page is out of date. Refresh to see the latest.
Showing with 34 additions and 2 deletions.
  1. +34 −2 README.markdown
View
36 README.markdown
@@ -50,12 +50,44 @@ enabled.
Installation
------------
-[pathogen.vim](https://github.com/tpope/vim-pathogen) is the recommended way to install syntastic.
+Installing syntastic is easy but first you need to have the pathogen plugin installed. If you already
+have pathogen working then skip Step 1 and go to Step 2.
+
+Step 1: Install pathogen.vim
+----------------------------
+
+First I'll show you how to install tpope's [pathogen.vim](https://github.com/tpope/vim-pathogen) so that
+it's easy to install syntastic. Do this in your Terminal so that you get the pathogen.vim file
+and the directories it needs:
+
+ mkdir -p ~/.vim/autoload ~/.vim/bundle; \
+ curl -so ~/.vim/autoload/pathogen.vim \
+ https://raw.github.com/tpope/vim-pathogen/master/autoload/pathogen.vim
+
+Next you *need to add this* to your ~/.vimrc:
+
+ call pathogen#infect()
+
+Step 2: Install syntastic as a pathogen bundle
+----------------------------------------------
+
+You now have pathogen installed and can put syntastic into ~/.vim/bundle like this:
+
cd ~/.vim/bundle
git clone https://github.com/scrooloose/syntastic.git
-Then reload vim, run `:Helptags`, and check out `:help syntastic.txt`.
+Quit vim and start it back up to reload it, then type:
+
+ :Helptags
+
+If you get an error when you do this, then you probably didn't install pathogen right. Go back to
+step 1 and make sure you did the following:
+
+1. Created both the ~/.vim/autoload and ~/.vim/bundle directories.
+2. Added the "call pathogen#infect()" line to your ~/.vimrc file
+3. Did the git clone of syntastic inside ~/.vim/bundle
+4. Have permissions to access all of these directories.
Google group
Something went wrong with that request. Please try again.