Mercurial > vim
annotate README.md @ 22389:995f5e061e27 v8.2.1743
patch 8.2.1743: cannot build without the eval feature
Commit: https://github.com/vim/vim/commit/273af497cac345897cf6369baa87a070876a5815
Author: Bram Moolenaar <Bram@vim.org>
Date: Fri Sep 25 23:49:01 2020 +0200
patch 8.2.1743: cannot build without the eval feature
Problem: Cannot build without the eval feature.
Solution: Move shorten_dir outside of #ifdef.
author | Bram Moolenaar <Bram@vim.org> |
---|---|
date | Sat, 26 Sep 2020 00:00:04 +0200 |
parents | 6e13105b5d07 |
children | 1984a3fcc953 |
rev | line source |
---|---|
14115
172ccc083d4a
patch 8.1.0075: no Vim logo in README file
Christian Brabandt <cb@256bit.org>
parents:
13963
diff
changeset
|
1 ![Vim Logo](https://github.com/vim/vim/blob/master/runtime/vimlogo.gif) |
172ccc083d4a
patch 8.1.0075: no Vim logo in README file
Christian Brabandt <cb@256bit.org>
parents:
13963
diff
changeset
|
2 |
18728
9f1cf1458708
patch 8.1.2354: Cirrus CI runs on another repository
Bram Moolenaar <Bram@vim.org>
parents:
18724
diff
changeset
|
3 [![Travis Build Status](https://travis-ci.org/vim/vim.svg?branch=master)](https://travis-ci.org/vim/vim) |
15879
ab5ee4f15e8e
patch 8.1.0946: Coveralls is not very useful
Bram Moolenaar <Bram@vim.org>
parents:
14746
diff
changeset
|
4 [![Appveyor Build status](https://ci.appveyor.com/api/projects/status/o2qht2kjm02sgghk?svg=true)](https://ci.appveyor.com/project/chrisbra/vim) |
21538
6e13105b5d07
patch 8.2.1319: status badge for Github CI has wrong link
Bram Moolenaar <Bram@vim.org>
parents:
21536
diff
changeset
|
5 [![Github Build status](https://github.com/vim/vim/workflows/GitHub%20CI/badge.svg)](https://github.com/vim/vim/actions?query=workflow%3A%22GitHub+CI%22) |
18728
9f1cf1458708
patch 8.1.2354: Cirrus CI runs on another repository
Bram Moolenaar <Bram@vim.org>
parents:
18724
diff
changeset
|
6 [![Cirrus Build Status](https://api.cirrus-ci.com/github/vim/vim.svg)](https://cirrus-ci.com/github/vim/vim) |
11248
c12b80e3d323
patch 8.0.0510: typo in link to codecov.io results
Christian Brabandt <cb@256bit.org>
parents:
11246
diff
changeset
|
7 [![Coverage Status](https://codecov.io/gh/vim/vim/coverage.svg?branch=master)](https://codecov.io/gh/vim/vim?branch=master) |
8619
5c9603b1084d
commit https://github.com/vim/vim/commit/8a82c7fa5ec55b59782f7a7846d6152ccf3a22c7
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
8 [![Coverity Scan](https://scan.coverity.com/projects/241/badge.svg)](https://scan.coverity.com/projects/vim) |
14493
85c085bae335
patch 8.1.0260: no LGTM logo in README file
Christian Brabandt <cb@256bit.org>
parents:
14119
diff
changeset
|
9 [![Language Grade: C/C++](https://img.shields.io/lgtm/grade/cpp/g/vim/vim.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/vim/vim/context:cpp) |
12754
5707872d5c07
patch 8.0.1255: duplicate badge README file
Christian Brabandt <cb@256bit.org>
parents:
12740
diff
changeset
|
10 [![Debian CI](https://badges.debian.net/badges/debian/testing/vim/version.svg)](https://buildd.debian.org/vim) |
15879
ab5ee4f15e8e
patch 8.1.0946: Coveralls is not very useful
Bram Moolenaar <Bram@vim.org>
parents:
14746
diff
changeset
|
11 [![Packages](https://repology.org/badge/tiny-repos/vim.svg)](https://repology.org/metapackage/vim) |
18664 | 12 For translations of this README see the end. |
6916 | 13 |
14 | |
7177
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
7137
diff
changeset
|
15 ## What is Vim? ## |
6916 | 16 |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
17 Vim is a greatly improved version of the good old UNIX editor Vi. Many new |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
18 features have been added: multi-level undo, syntax highlighting, command line |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
19 history, on-line help, spell checking, filename completion, block operations, |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
20 script language, etc. There is also a Graphical User Interface (GUI) |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
21 available. Still, Vi compatibility is maintained, those who have Vi "in the |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
22 fingers" will feel at home. See `runtime/doc/vi_diff.txt` for differences with |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
23 Vi. |
6916 | 24 |
25 This editor is very useful for editing programs and other plain text files. | |
26 All commands are given with normal keyboard characters, so those who can type | |
27 with ten fingers can work very fast. Additionally, function keys can be | |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
28 mapped to commands by the user, and the mouse can be used. |
6916 | 29 |
20134
352701a626ed
patch 8.2.0622: Haiku: GUI does not compile
Bram Moolenaar <Bram@vim.org>
parents:
19181
diff
changeset
|
30 Vim runs under MS-Windows (XP, Vista, 7, 8, 10), macOS, Haiku, VMS and almost |
352701a626ed
patch 8.2.0622: Haiku: GUI does not compile
Bram Moolenaar <Bram@vim.org>
parents:
19181
diff
changeset
|
31 all flavours of UNIX. Porting to other systems should not be very difficult. |
19125
286aa7c0c9ab
patch 8.2.0122: readme files still mention MS-DOS
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
32 Older versions of Vim run on MS-DOS, MS-Windows 95/98/Me/NT/2000, Amiga DOS, |
286aa7c0c9ab
patch 8.2.0122: readme files still mention MS-DOS
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
33 Atari MiNT, BeOS, RISC OS and OS/2. These are no longer maintained. |
6916 | 34 |
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19125
diff
changeset
|
35 For Vim9 script see [README_VIM9](README_VIM9.md). |
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19125
diff
changeset
|
36 |
6916 | 37 ## Distribution ## |
38 | |
7177
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
7137
diff
changeset
|
39 You can often use your favorite package manager to install Vim. On Mac and |
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
7137
diff
changeset
|
40 Linux a small version of Vim is pre-installed, you still need to install Vim |
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
7137
diff
changeset
|
41 if you want more features. |
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
7137
diff
changeset
|
42 |
6916 | 43 There are separate distributions for Unix, PC, Amiga and some other systems. |
44 This `README.md` file comes with the runtime archive. It includes the | |
45 documentation, syntax files and other files that are used at runtime. To run | |
46 Vim you must get either one of the binary archives or a source archive. | |
47 Which one you need depends on the system you want to run it on and whether you | |
48 want or must compile it yourself. Check http://www.vim.org/download.php for | |
49 an overview of currently available distributions. | |
50 | |
8917
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
51 Some popular places to get the latest Vim: |
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
52 * Check out the git repository from [github](https://github.com/vim/vim). |
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
53 * Get the source code as an [archive](https://github.com/vim/vim/releases). |
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
54 * Get a Windows executable from the |
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
55 [vim-win32-installer](https://github.com/vim/vim-win32-installer/releases) repository. |
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
56 |
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
57 |
6916 | 58 |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
59 ## Compiling ## |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
60 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
61 If you obtained a binary distribution you don't need to compile Vim. If you |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
62 obtained a source distribution, all the stuff for compiling Vim is in the |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
63 `src` directory. See `src/INSTALL` for instructions. |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
64 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
65 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
66 ## Installation ## |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
67 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
68 See one of these files for system-specific instructions. Either in the |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
69 READMEdir directory (in the repository) or the top directory (if you unpack an |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
70 archive): |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
71 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
72 README_ami.txt Amiga |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
73 README_unix.txt Unix |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
74 README_dos.txt MS-DOS and MS-Windows |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
75 README_mac.txt Macintosh |
20134
352701a626ed
patch 8.2.0622: Haiku: GUI does not compile
Bram Moolenaar <Bram@vim.org>
parents:
19181
diff
changeset
|
76 README_haiku.txt Haiku |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
77 README_vms.txt VMS |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
78 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
79 There are other `README_*.txt` files, depending on the distribution you used. |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
80 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
81 |
6916 | 82 ## Documentation ## |
83 | |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
84 The Vim tutor is a one hour training course for beginners. Often it can be |
6916 | 85 started as `vimtutor`. See `:help tutor` for more information. |
86 | |
87 The best is to use `:help` in Vim. If you don't have an executable yet, read | |
88 `runtime/doc/help.txt`. It contains pointers to the other documentation | |
89 files. The User Manual reads like a book and is recommended to learn to use | |
90 Vim. See `:help user-manual`. | |
91 | |
92 | |
93 ## Copying ## | |
94 | |
95 Vim is Charityware. You can use and copy it as much as you like, but you are | |
96 encouraged to make a donation to help orphans in Uganda. Please read the file | |
97 `runtime/doc/uganda.txt` for details (do `:help uganda` inside Vim). | |
98 | |
99 Summary of the license: There are no restrictions on using or distributing an | |
100 unmodified copy of Vim. Parts of Vim may also be distributed, but the license | |
101 text must always be included. For modified versions a few restrictions apply. | |
102 The license is GPL compatible, you may compile Vim with GPL libraries and | |
103 distribute it. | |
104 | |
105 | |
106 ## Sponsoring ## | |
107 | |
108 Fixing bugs and adding new features takes a lot of time and effort. To show | |
109 your appreciation for the work and motivate Bram and others to continue | |
110 working on Vim please send a donation. | |
111 | |
112 Since Bram is back to a paid job the money will now be used to help children | |
113 in Uganda. See `runtime/doc/uganda.txt`. But at the same time donations | |
114 increase Bram's motivation to keep working on Vim! | |
115 | |
116 For the most recent information about sponsoring look on the Vim web site: | |
117 http://www.vim.org/sponsor/ | |
118 | |
119 | |
7127
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
120 ## Contributing ## |
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
121 |
7179
f7d6cc6b78b5
commit https://github.com/vim/vim/commit/f1a4c98ea6fa122ceb24c1ad17e184703cbfd182
Christian Brabandt <cb@256bit.org>
parents:
7177
diff
changeset
|
122 If you would like to help making Vim better, see the [CONTRIBUTING.md](https://github.com/vim/vim/blob/master/CONTRIBUTING.md) file. |
7127
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
123 |
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
124 |
6916 | 125 ## Information ## |
126 | |
127 The latest news about Vim can be found on the Vim home page: | |
128 http://www.vim.org/ | |
129 | |
130 If you have problems, have a look at the Vim documentation or tips: | |
131 http://www.vim.org/docs.php | |
132 http://vim.wikia.com/wiki/Vim_Tips_Wiki | |
133 | |
134 If you still have problems or any other questions, use one of the mailing | |
135 lists to discuss them with Vim users and developers: | |
136 http://www.vim.org/maillist.php | |
137 | |
138 If nothing else works, report bugs directly: | |
139 Bram Moolenaar <Bram@vim.org> | |
140 | |
141 | |
142 ## Main author ## | |
143 | |
144 Send any other comments, patches, flowers and suggestions to: | |
145 Bram Moolenaar <Bram@vim.org> | |
14119
b5b0b87f1a39
patch 8.1.0077: header of README file is not nice
Christian Brabandt <cb@256bit.org>
parents:
14115
diff
changeset
|
146 |
b5b0b87f1a39
patch 8.1.0077: header of README file is not nice
Christian Brabandt <cb@256bit.org>
parents:
14115
diff
changeset
|
147 |
18879 | 148 This is `README.md` for version 8.2 of Vim: Vi IMproved. |
18664 | 149 |
150 | |
151 ## Translations of this README ## | |
152 | |
153 [Korean](https://github.com/cjw1359/opensource/blob/master/Vim/README_ko.md) |