You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.markdown
+52-70Lines changed: 52 additions & 70 deletions
Original file line number
Diff line number
Diff line change
@@ -1,80 +1,44 @@
1
1
# spf13-vim : Steve Francia's Vim Distribution
2
2
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].
4
11
5
12
It is a good starting point for anyone intending to use VIM for development running equally well on Windows, Linux, *nix and Mac.
6
13
7
14
The distribution is completely customisable using a `~/.vimrc.local` and `~/.vimrc.bundles.local` Vim RC files.
8
15
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.
10
19
11
20
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.
12
21
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.
14
23
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.
18
26
19
-
### Changes from 2 to 3
20
27
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.
21
28
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.
51
30
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.
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.
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
150
118
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.
151
120
152
121
# spf13-vim Features
153
122
154
123
## A highly optimized .vimrc config file
155
124
125
+
![spf13-vimrc image][spf13-vimrc-img]
126
+
156
127
The .vimrc file is suited to programming. It is extremely well organized and folds in sections.
157
128
Each section is labeled and each option is commented.
158
129
159
130
It fixes many of the inconveniences of vanilla vim including
160
131
161
-
*One config can be used across Windows, Mac and linux
132
+
*A single config can be used across Windows, Mac and linux
162
133
* Eliminates swap and backup files from littering directories, preferring to store in a central location.
163
134
* Fixes common typos like :W, :Q, etc
164
135
* 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
174
145
175
146
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.
176
147
177
-
Most of the bundles are git submodules facilitating easy updating and configuration.
148
+
Here are a few of the plugins:
178
149
179
150
*[PIV (PHP Integration for VIM)](http://github.com/spf13/PIV)
0 commit comments