vim_extended: adjust the feature branch names
[vim_extended.git] / readme_vim_extended.htm
blob5197a780b969d5bd050d53d108d41f536c4e66a3
1 <p>
2 Vim extended is based on the official Vim from
3 <a href="http://www.vim.org/">vim.org</a>. It includes various
4 extensions and features that didn't yet get into the official version
5 or even won't ever. Most features had been sent as patches to the Vim
6 mailing list.
7 </p>
9 <p>
10 See also the
11 <a href="http://groups.google.com/group/vim_dev/web/vim-patches">
12 Vim patches</a> site.
13 </p>
15 <p>
16 <strong>NOTE</strong>: This repository is based on
17 <a href="http://repo.or.cz/w/vim_mainline.git">vim_mainline.git</a>,
18 which is currently based on Vim's svn access with git-svn, but will be
19 based on plain tarballs and patches some time. So vim_mainline.git and
20 hence vim_extended.git will definitely be <strong>rebased</strong>
21 (better say: <strong>completely rewritten</strong>). So keep this in
22 mind when using this repository as base for your work.
23 </p>
25 <h3>Use Vim extended</h3>
27 <ul>
28 <li>
29 get the whole repository over the git or HTTP protocol<br />
30 <pre>git clone git://repo.or.cz/vim_extended.git<br />git clone http://repo.or.cz/r/vim_extended.git</pre>
31 </li>
32 <li>
33 edit and build as usual<br />
34 <pre>vim; make; make install</pre>
35 </li>
36 <li>
37 get updates from the repository<br />
38 <pre>git pull</pre>
39 </li>
40 </ul>
42 <table>
43 <tr>
44 <th>Branch</th>
45 <th>Description</th>
46 </tr>
47 <tr>
48 <td>
49 <a href="http://repo.or.cz/w/vim_extended.git?a=blobdiff_plain;hp=vim;h=master" title="Patch against official Vim"><em>master</em></a>
50 </td>
51 <td>
52 Extended Vim<br />
53 Merges <em>vim-with-runtime</em> and all the feature branches.<br />
54 The only modification is the "Modified by" entry for the version output.
55 </td>
56 </tr>
57 <tr>
58 <td><em>vim-with-runtime</em></td>
59 <td>
60 Official Vim with latest runtime files<br />
61 The <em>master</em> branch of the <a href="http://repo.or.cz/w/vim_mainline.git">vim_mainline.git</a> repository.
62 </td>
63 </tr>
64 <tr>
65 <td><em>vim</em></td>
66 <td>
67 Official Vim<br />
68 The <em>vim</em> branch of the <a href="http://repo.or.cz/w/vim_mainline.git">vim_mainline.git</a> repository.
69 </td>
70 </tr>
71 <tr>
72 <td><em>vim-runtime</em></td>
73 <td>
74 Vim's latest runtime files<br />
75 The <em>vim-runtime</em> branch of the <a href="http://repo.or.cz/w/vim_mainline.git">vim_mainline.git</a> repository.
76 </td>
77 </tr>
78 <tr>
79 <td><em>stuff</em></td>
80 <td>
81 Scripts and documentation used to use and manage this repository<br />
82 The <em>stuff</em> branch of the <a href="http://repo.or.cz/w/vim_mainline.git">vim_mainline.git</a> repository.
83 </td>
84 </tr>
85 <tr>
86 <td style="border-top:1px black solid;">feature branches</td>
87 <td style="border-top:1px black solid;">
88 Extensions, features, external patches<br />
89 Based on <em>vim</em>
90 </td>
91 </tr>
92 <tr>
93 <td>
94 <a href="http://repo.or.cz/w/vim_extended.git?a=blobdiff_plain;hp=vim;h=feat/rel-line-numbers" title="Patch against official Vim"><em>feat/rel-line-numbers</em></a>
95 </td>
96 <td>
97 'relativenumber' option to display relative line numbers
98 </td>
99 </tr>
100 <tr>
101 <td>
102 <a href="http://repo.or.cz/w/vim_extended.git?a=blobdiff_plain;hp=vim;h=feat/float-point-ext" title="Patch against official Vim"><em>feat/float-point-ext</em></a>
103 </td>
104 <td>
105 extended floating point functions
106 </td>
107 </tr>
108 <tr>
109 <td>
110 <a href="http://repo.or.cz/w/vim_extended.git?a=blobdiff_plain;hp=vim;h=feat/lua" title="Patch against official Vim"><em>feat/lua</em></a>
111 </td>
112 <td>
113 interface to the programming language Lua
114 </td>
115 </tr>
116 <tr>
117 <td>
118 <a href="http://repo.or.cz/w/vim_extended.git?a=blobdiff_plain;hp=vim;h=feat/code-check" title="Patch against official Vim"><em>feat/code-check</em></a>
119 </td>
120 <td>
121 on-the-fly code checker
122 </td>
123 </tr>
124 <tr>
125 <td>
126 <a href="http://repo.or.cz/w/vim_extended.git?a=blobdiff_plain;hp=vim;h=feat/var-tabstops" title="Patch against official Vim"><em>feat/var-tabstops</em></a>
127 </td>
128 <td>
129 different widths for each tabstop
130 </td>
131 </tr>
132 <tr>
133 <td>
134 <a href="http://repo.or.cz/w/vim_extended.git?a=blobdiff_plain;hp=vim;h=feat/emb-common-lisp" title="Patch against official Vim"><em>feat/emb-common-lisp</em></a>
135 </td>
136 <td>
137 interface to the programming language ECL (Embeddable Common Lisp)
138 </td>
139 </tr>
140 </table>