add maintainer with name and email address
[vim_extended.git] / readme_vim_extended.htm
blob65d671fd8bee149853a11eb9b25ef89e7a7bb3b4
1 <p>
2 This is a git repository, which is meant to be an extension to the
3 official Vim from <a href="http://www.vim.org/">vim.org</a>. It
4 includes various extensions and features that didn't yet get into the
5 official version or even won't ever. Most features had been sent as
6 patches to the Vim 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 Please note that there is no official support for this from Bram. The
17 patches will most likely work and they appear to do so for several
18 people. However, you might get unlucky and stuff breaks. At worst, you
19 could lose your data. So please be aware of this before going down
20 this road.
21 </p>
23 <p>
24 <strong>NOTE</strong>: This repository is based on
25 <a href="http://repo.or.cz/w/vim_mainline.git">vim_mainline.git</a>,
26 which is currently based on Vim's svn access with git-svn, but will be
27 based on plain tarballs and patches some time. So vim_mainline.git and
28 hence vim_extended.git will definitely be <strong>rebased</strong>
29 (better say: <strong>completely rewritten</strong>). So keep this in
30 mind when using this repository as base for your work.
31 </p>
33 <p>
34 Maintainer: <a href="mailto:markus.heidelberg@web.de">Markus Heidelberg</a>
35 </p>
37 <h3>Use Vim extended</h3>
39 <ul>
40 <li>
41 get the whole repository over the git or HTTP protocol<br />
42 <pre>git clone git://repo.or.cz/vim_extended.git<br />git clone http://repo.or.cz/r/vim_extended.git</pre>
43 </li>
44 <li>
45 edit and build as usual<br />
46 <pre>vim; make; make install</pre>
47 </li>
48 <li>
49 get updates from the repository<br />
50 <pre>git pull</pre>
51 </li>
52 </ul>
54 <table>
55 <tr>
56 <th>Branch</th>
57 <th>Description</th>
58 </tr>
59 <tr>
60 <td>
61 <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>
62 </td>
63 <td>
64 Extended Vim<br />
65 Merges <em>vim-with-runtime</em> and all the feature branches.<br />
66 The only modification is the "Modified by" entry for the version output.
67 </td>
68 </tr>
69 <tr>
70 <td><em>vim-with-runtime</em></td>
71 <td>
72 Official Vim with latest runtime files<br />
73 The <em>master</em> branch of the <a href="http://repo.or.cz/w/vim_mainline.git">vim_mainline.git</a> repository.
74 </td>
75 </tr>
76 <tr>
77 <td><em>vim</em></td>
78 <td>
79 Official Vim<br />
80 The <em>vim</em> branch of the <a href="http://repo.or.cz/w/vim_mainline.git">vim_mainline.git</a> repository.
81 </td>
82 </tr>
83 <tr>
84 <td><em>vim-runtime</em></td>
85 <td>
86 Vim's latest runtime files<br />
87 The <em>vim-runtime</em> branch of the <a href="http://repo.or.cz/w/vim_mainline.git">vim_mainline.git</a> repository.
88 </td>
89 </tr>
90 <tr>
91 <td><em>stuff</em></td>
92 <td>
93 Scripts and documentation used to use and manage this repository<br />
94 The <em>stuff</em> branch of the <a href="http://repo.or.cz/w/vim_mainline.git">vim_mainline.git</a> repository.
95 </td>
96 </tr>
97 <tr>
98 <td style="border-top:1px black solid;">feature branches</td>
99 <td style="border-top:1px black solid;">
100 Extensions, features, external patches<br />
101 Based on <em>vim</em>
102 </td>
103 </tr>
104 <tr>
105 <td>
106 <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>
107 </td>
108 <td>
109 'relativenumber' option to display relative line numbers
110 </td>
111 </tr>
112 <tr>
113 <td>
114 <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>
115 </td>
116 <td>
117 extended floating point functions
118 </td>
119 </tr>
120 <tr>
121 <td>
122 <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>
123 </td>
124 <td>
125 interface to the programming language Lua
126 </td>
127 </tr>
128 <tr>
129 <td>
130 <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>
131 </td>
132 <td>
133 on-the-fly code checker
134 </td>
135 </tr>
136 <tr>
137 <td>
138 <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>
139 </td>
140 <td>
141 different widths for each tabstop
142 </td>
143 </tr>
144 <tr>
145 <td>
146 <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>
147 </td>
148 <td>
149 interface to the programming language ECL (Embeddable Common Lisp)
150 </td>
151 </tr>
152 </table>