Skip to content

Commit 9a2af6a

Browse files
committed
More work on readme file (adding images).
1 parent c5e097c commit 9a2af6a

File tree

2 files changed

+59
-79
lines changed

2 files changed

+59
-79
lines changed

.vimrc

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,11 @@
6464
Bundle 'Lokaltog/vim-easymotion'
6565
Bundle 'godlygeek/csapprox'
6666
Bundle 'jistr/vim-nerdtree-tabs'
67+
Bundle 'flazz/vim-colorschemes'
6768

6869
" General Programming
6970
" Pick one of the checksyntax, jslint, or syntastic
70-
Bundle 'Syntastic'
71+
Bundle 'scrooloose/syntastic'
7172
Bundle 'garbas/vim-snipmate'
7273
Bundle 'spf13/snipmate-snippets'
7374
Bundle 'tpope/vim-fugitive'
@@ -107,17 +108,14 @@
107108
" General {
108109
set background=dark " Assume a dark background
109110
if !has('gui')
110-
set term=$TERM " Make arrow and other keys work
111+
"set term=$TERM " Make arrow and other keys work
111112
endif
112113
filetype plugin indent on " Automatically detect file types.
113114
syntax on " syntax highlighting
114115
set mouse=a " automatically enable mouse usage
115-
"set autochdir " always switch to the current file directory.. Messes with some plugins, best left commented out
116-
" not every vim is compiled with this, use the following line instead
117-
118-
" If you use command-t plugin, it conflicts with this, comment it out.
119-
autocmd BufEnter * if bufname("") !~ "^\[A-Za-z0-9\]*://" | lcd %:p:h | endif
120116
scriptencoding utf-8
117+
autocmd BufEnter * if bufname("") !~ "^\[A-Za-z0-9\]*://" | lcd %:p:h | endif
118+
" always switch to the current file directory.
121119

122120
" set autowrite " automatically write a file when leaving a modified buffer
123121
set shortmess+=filmnrxoOtT " abbrev. of messages (avoids 'hit enter')
@@ -398,7 +396,7 @@
398396
nmap <leader>jt <Esc>:%!python -m json.tool<CR><Esc>:set filetype=json<CR>
399397
" }
400398

401-
" } PyMode
399+
" PyMode {
402400
let g:pymode_lint_checker = "pyflakes"
403401
" }
404402

@@ -494,7 +492,7 @@
494492
set transparency=5 " Make the window slightly transparent
495493
endif
496494
else
497-
set term=builtin_ansi " Make arrow and other keys work
495+
"set term=builtin_ansi " Make arrow and other keys work
498496
endif
499497
" }
500498

README.markdown

Lines changed: 52 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1,80 +1,44 @@
11
# spf13-vim : Steve Francia's Vim Distribution
22

3-
spf13-vim is a distribution of vim plugins and resources for Vim, Gvim and MacVim.
3+
__ _ _____ _
4+
___ _ __ / _/ |___ / __ __(_)_ __ ___
5+
/ __| '_ \| |_| | |_ \ _____\ \ / /| | '_ ` _ \
6+
\__ \ |_) | _| |___) |_____|\ V / | | | | | | |
7+
|___/ .__/|_| |_|____/ \_/ |_|_| |_| |_|
8+
|_|
9+
10+
spf13-vim is a distribution of vim plugins and resources for Vim, Gvim and [MacVim].
411

512
It is a good starting point for anyone intending to use VIM for development running equally well on Windows, Linux, *nix and Mac.
613

714
The distribution is completely customisable using a `~/.vimrc.local` and `~/.vimrc.bundles.local` Vim RC files.
815

9-
Unlike traditional VIM plugin structure, which similar to UNIX throws all files into common directories, making updating or disabling plugins a real mess, spf13-vim 3 uses [Vundle] to have a well organized vim directory (Similar to mac's app folders). Vundle also ensures that the latest versions of your plugins are installed and makes it easy to keep them up to date.
16+
![spf13-vim image][spf13-vim-img]
17+
18+
Unlike traditional VIM plugin structure, which similar to UNIX throws all files into common directories, making updating or disabling plugins a real mess, spf13-vim 3 uses the [Vundle] plugin management system to have a well organized vim directory (Similar to mac's app folders). Vundle also ensures that the latest versions of your plugins are installed and makes it easy to keep them up to date.
1019

1120
Great care has been taken to ensure that each plugin plays nicely with others, and optional configuration has been provided for what we believe is the most efficient use.
1221

13-
Lastly (and perhaps, most importantly) It is completely cross platform. It works well on Windows, Linux and OSX without any modifications or additional configurations. If you are using [MacVim](http://code.google.com/p/macvim/) or Gvim additional features are enabled. So regardless of your environment just clone and run.
22+
Lastly (and perhaps, most importantly) It is completely cross platform. It works well on Windows, Linux and OSX without any modifications or additional configurations. If you are using [MacVim] or Gvim additional features are enabled. So regardless of your environment just clone and run.
1423

15-
## spf13-vim version 3?
16-
Wait, did we skip 2? No.. Version 1 was just my config prior to git. Version 2 was all git submodules.
17-
Version 3 is [Vundle] based. Prior to now there wasn't really a need to version them... it was just for me after all. Now hundreds of people are using this, so I figured with a major change I'd actually use version numbers.
24+
# spf13-vim 3.0
25+
January 2012 spf13-vim released it's third major iteration. **This is important as it requires a reinstall**, but trust me it's worth it.
1826

19-
### Changes from 2 to 3
2027
The biggest change is the switch from using git submodules to using the excellent [Vundle] system. While git submodules seemed like a good idea at the time, it wasn't. It was always problematic. Additionally because a submodule points to a refspec and not a branch, it was a constant maintenance nightmare to keep everything up to date.
2128

22-
[Vundle] has an excellent system built on the same principles as Pathogen, but with an integrated installer. [Vundle] supports git and has very easy configuration which happens in the vimrc file.
23-
24-
There are also a bunch of small changes and a focus on keeping a tighter set of plugins and keeping true to the defaults and standards vim expects. The goal has always been to add functionality without changing all the features, functionality and keystrokes we all love. Using spf13-vim we've kept all the default behaviors (by and large), so if you ever find yourself on a vanilla environment you'll feel right at home.
25-
26-
## Pre-requisites
27-
28-
spf13-vim is built to be completely cross platform. It works equally well on console vim as it does on gVim for Windows, \*nix or MacVim.
29-
30-
spf13-vim is dependent on a semi-recent version of VIM and should work well on anything above VIM 7.0.
31-
32-
[Git] is required for installation. Certain plugins may require python or ruby support to be compiled into VIM.
33-
34-
To check if you have python or ruby support run
35-
36-
:echo has('ruby')
37-
38-
If it returns 1 your vim supports ruby.
39-
40-
## Installing on \*nix (MacOS X, Linux, etc)
41-
42-
### Easy Installation (\*nix only)
43-
44-
```bash
45-
curl http://j.mp/spf13-vim3 -o - | sh
46-
```
47-
48-
or
49-
50-
### Manual Installation
29+
[Vundle] has an excellent system built on the same principles as Pathogen, but with an integrated plugin management system that is Git and Github aware.
5130

52-
#### Backup existing vim configuration
31+
We have also changed out most of the plugins in favor of newer more stable alternatives. Additionally we have significantly reduced the number of plugins requiring python or ruby.
5332

54-
```bash
55-
today=`date +%Y%m%d`
56-
for i in $HOME/.vim $HOME/.vimrc $HOME/.gvimrc; do [ -e $i ] && mv $i $i.$today; done
57-
```
33+
The goal has always been to add functionality without changing all the features, functionality and keystrokes we all love. Using spf13-vim we've kept all the default behaviors (by and large), so if you ever find yourself on a vanilla environment you'll feel right at home.
5834

59-
#### Clone spf13-vim from github
60-
```bash
61-
endpath="$HOME/.spf13-vim-3"
62-
git clone --recursive -b 3.0 git://github.com/spf13/spf13-vim.git $endpath
63-
mkdir -p $endpath/.vim/bundle
64-
ln -s $endpath/.vimrc ~/.vimrc
65-
ln -s $endpath/.vim ~/.vim
66-
```
35+
# Installation
6736

68-
_Use ln -s on mac/unix or mklink on windows._
37+
## Linux, \*nix, Mac OSX Installation
6938

70-
#### Installing Vundle
7139
```bash
72-
git clone http://github.com/gmarik/vundle.git $HOME/.vim/bundle/vundle
73-
```
7440

75-
#### Install plugins using Vundle
76-
```bash
77-
vim +BundleInstall! +BundleClean +q
41+
curl http://j.mp/spf13-vim3 -o - | sh
7842
```
7943

8044
## Installing on Windows
@@ -120,14 +84,14 @@ to verify all good, run:
12084
Features: Largefile NTLM SSL SSPI libz
12185

12286

123-
#### Installing spf13-vim on Windows
87+
#### Installing spf13-vim on Windows
12488

12589
The easiest way is to download and run the spf13-vim-windows-install.cmd file.
12690

12791
## Updating to the latest version
12892

12993
```bash
130-
cd /path/to/spf13-vim/
94+
cd $HOME/to/spf13-vim/
13195
git pull
13296
vim +BundleInstall! +BundleClean +q
13397
```
@@ -137,28 +101,35 @@ The easiest way is to download and run the spf13-vim-windows-install.cmd file.
137101
Create `~/.vimrc.local` and `~/.gvimrc.local` for any local
138102
customizations.
139103

104+
Create `~/.vimrc.bundles.local` for any additional bundles.
105+
140106
For example, to override the default color schemes:
141107

142108
```bash
143-
echo color desert > ~/.vimrc.local
144-
echo color molokai > ~/.gvimrc.local
109+
echo colorscheme ir_black >> ~/.vimrc.local
145110
```
111+
Or to add a new bundle
146112

147-
### Fork me on GitHub
113+
```bash
114+
echo Bundle \'spf13/vim-colors\' >> ~/.vimrc.bundles.local
115+
```
148116

149-
I'm always happy to take pull requests from others. A good number of people have already contributed to spf13-vim. Go ahead and fork me.
117+
### Fork me on GitHub
150118

119+
I'm always happy to take pull requests from others. A good number of people are already [contributors] to [spf13-vim]. Go ahead and fork me.
151120

152121
# spf13-vim Features
153122

154123
## A highly optimized .vimrc config file
155124

125+
![spf13-vimrc image][spf13-vimrc-img]
126+
156127
The .vimrc file is suited to programming. It is extremely well organized and folds in sections.
157128
Each section is labeled and each option is commented.
158129

159130
It fixes many of the inconveniences of vanilla vim including
160131

161-
* One config can be used across Windows, Mac and linux
132+
* A single config can be used across Windows, Mac and linux
162133
* Eliminates swap and backup files from littering directories, preferring to store in a central location.
163134
* Fixes common typos like :W, :Q, etc
164135
* Setup a solid set of settings for Formatting (change to meet your needs)
@@ -174,19 +145,20 @@ It fixes many of the inconveniences of vanilla vim including
174145

175146
spf13-vim contains a curated set of popular vim plugins, colors, snippets and syntaxes. Great care has been made to ensure that these plugins play well together and have optimal configuration.
176147

177-
Most of the bundles are git submodules facilitating easy updating and configuration.
148+
Here are a few of the plugins:
178149

179150
* [PIV (PHP Integration for VIM)](http://github.com/spf13/PIV)
180-
* [Snipmate](http://github.com/msanders/snipmate.vim)
181151
* [NerdCommenter](http://github.com/scrooloose/nerdcommenter)
182152
* [NerdTree](http://github.com/scrooloose/nerdtree)
183-
* [SuperTab](http://www.vim.org/scripts/script.php?script_id=1643)
153+
* [ctrlp](http://github.com/kien/ctrlp)
154+
* [solarized](http://github.com/altercation/vim-colors-solarized)
155+
* [neocomplcache](http://github.com/shougo/neocomplcache)
184156
* [Fugitive](http://github.com/tpope/vim-fugitive)
185-
* [DelimitMate](http://github.com/Raimondi/delimitMate)
157+
* [Surround](https://github.com/tpope/vim-surround)
158+
* [tabular](http://github.com/godlygeek/tagbar)
159+
* [syntastic](http://github.com/scrooloose/syntastic)
160+
* [vim-easymotion](http://github.com/Lokaltog/vim-easymotion)
186161
* [Matchit](http://www.vim.org/scripts/script.php?script_id=39)
187-
* [CheckSyntax](http://www.vim.org/scripts/script.php?script_id=1431)
188-
* [Surrounding](http://github.com/msanders/vim-files/blob/master/plugin/surrounding.vim)
189-
* [AutoCloseTag](http://www.vim.org/scripts/script.php?script_id=2591)
190162

191163
### NERDTree
192164

@@ -410,3 +382,13 @@ Here's some tips if you've never used VIM before:
410382
[Git]:http://git-scm.com
411383
[Curl]:http://curl.haxx.se
412384
[msysgit]:http://code.google.com/p/msysgit
385+
[MacVim]:http://code.google.com/p/macvim/
386+
[spf13-vim]:https://github.com/spf13/spf13-vim
387+
[contributors]:https://github.com/spf13/spf13-vim/contributors
388+
[spf13-vim-img]:http://i.imgur.com/UKToY.png
389+
[spf13-vimrc-img]:http://i.imgur.com/kZWj1.png
390+
[autocomplete-img]:http://i.imgur.com/90Gg7.png
391+
[tagbar-img]:http://i.imgur.com/cjbrC.png
392+
[fugitive-img]:http://i.imgur.com/4NrxV.png
393+
[nerdtree-img]:http://i.imgur.com/9xIfu.png
394+
[phpmanual-img]:http://i.imgur.com/c0GGP.png

0 commit comments

Comments
 (0)