vim_extended: add the NOTE from vim_mainline
[vim_extended.git] / readme_vim_extended.htm
blob9f33ce963f91b01c8697811c3ab72dfb74b296d3
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 --with-modified-by configure option.
55 </td>
56 </tr>
57 <tr>
58 <td><em>vim</em></td>
59 <td>
60 Official Vim<br />
61 The <em>vim</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-with-runtime</em></td>
66 <td>
67 Official Vim with latest runtime files<br />
68 The <em>master</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 style="border-top:1px black solid;">feature branches</td>
73 <td style="border-top:1px black solid;">
74 Extensions, features, external patches<br />
75 Based on <em>vim</em>
76 </td>
77 </tr>
78 <tr>
79 <td>
80 <a href="http://repo.or.cz/w/vim_extended.git?a=blobdiff_plain;hp=vim;h=relativenumber" title="Patch against official Vim"><em>relativenumber</em></a>
81 </td>
82 <td>
83 'relativenumber' option to display relative line numbers
84 </td>
85 </tr>
86 <tr>
87 <td>
88 <a href="http://repo.or.cz/w/vim_extended.git?a=blobdiff_plain;hp=vim;h=floating_point" title="Patch against official Vim"><em>floating_point</em></a>
89 </td>
90 <td>
91 extended floating point functions
92 </td>
93 </tr>
94 <tr>
95 <td>
96 <a href="http://repo.or.cz/w/vim_extended.git?a=blobdiff_plain;hp=vim;h=lua_interface" title="Patch against official Vim"><em>lua_interface</em></a>
97 </td>
98 <td>
99 interface to the programming language Lua
100 </td>
101 </tr>
102 <tr>
103 <td>
104 <a href="http://repo.or.cz/w/vim_extended.git?a=blobdiff_plain;hp=vim;h=code_checking" title="Patch against official Vim"><em>code_checking</em></a>
105 </td>
106 <td>
107 on-the-fly code checker
108 </td>
109 </tr>
110 <tr>
111 <td>
112 <a href="http://repo.or.cz/w/vim_extended.git?a=blobdiff_plain;hp=vim;h=variable_tabstops" title="Patch against official Vim"><em>variable_tabstops</em></a>
113 </td>
114 <td>
115 different widths for each tabstop
116 </td>
117 </tr>
118 <tr>
119 <td>
120 <a href="http://repo.or.cz/w/vim_extended.git?a=blobdiff_plain;hp=vim;h=ecl_interface" title="Patch against official Vim"><em>ecl_interface</em></a>
121 </td>
122 <td>
123 interface to the programming language ECL (Embeddable Common Lisp)
124 </td>
125 </tr>
126 </table>