Mercurial > vim
annotate README.md @ 20872:4b47824b3f1e
Added tag v8.2.0987 for changeset 65d9189d4dca2f80a3941b3d9cea87c32a25d675
author | Bram Moolenaar <Bram@vim.org> |
---|---|
date | Tue, 16 Jun 2020 11:45:05 +0200 |
parents | 352701a626ed |
children | 4cce42c43c10 |
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) |
18728
9f1cf1458708
patch 8.1.2354: Cirrus CI runs on another repository
Bram Moolenaar <Bram@vim.org>
parents:
18724
diff
changeset
|
5 [![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
|
6 [![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
|
7 [![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
|
8 [![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
|
9 [![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
|
10 [![Packages](https://repology.org/badge/tiny-repos/vim.svg)](https://repology.org/metapackage/vim) |
18664 | 11 For translations of this README see the end. |
6916 | 12 |
13 | |
7177
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
7137
diff
changeset
|
14 ## What is Vim? ## |
6916 | 15 |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
16 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
|
17 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
|
18 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
|
19 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
|
20 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
|
21 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
|
22 Vi. |
6916 | 23 |
24 This editor is very useful for editing programs and other plain text files. | |
25 All commands are given with normal keyboard characters, so those who can type | |
26 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
|
27 mapped to commands by the user, and the mouse can be used. |
6916 | 28 |
20134
352701a626ed
patch 8.2.0622: Haiku: GUI does not compile
Bram Moolenaar <Bram@vim.org>
parents:
19181
diff
changeset
|
29 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
|
30 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
|
31 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
|
32 Atari MiNT, BeOS, RISC OS and OS/2. These are no longer maintained. |
6916 | 33 |
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19125
diff
changeset
|
34 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
|
35 |
6916 | 36 ## Distribution ## |
37 | |
7177
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
7137
diff
changeset
|
38 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
|
39 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
|
40 if you want more features. |
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
7137
diff
changeset
|
41 |
6916 | 42 There are separate distributions for Unix, PC, Amiga and some other systems. |
43 This `README.md` file comes with the runtime archive. It includes the | |
44 documentation, syntax files and other files that are used at runtime. To run | |
45 Vim you must get either one of the binary archives or a source archive. | |
46 Which one you need depends on the system you want to run it on and whether you | |
47 want or must compile it yourself. Check http://www.vim.org/download.php for | |
48 an overview of currently available distributions. | |
49 | |
8917
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
50 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
|
51 * 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
|
52 * 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
|
53 * Get a Windows executable from the |
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
54 [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
|
55 |
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
56 |
6916 | 57 |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
58 ## Compiling ## |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
59 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
60 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
|
61 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
|
62 `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
|
63 |
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 ## Installation ## |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
66 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
67 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
|
68 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
|
69 archive): |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
70 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
71 README_ami.txt Amiga |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
72 README_unix.txt Unix |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
73 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
|
74 README_mac.txt Macintosh |
20134
352701a626ed
patch 8.2.0622: Haiku: GUI does not compile
Bram Moolenaar <Bram@vim.org>
parents:
19181
diff
changeset
|
75 README_haiku.txt Haiku |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
76 README_vms.txt VMS |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
77 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
78 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
|
79 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
80 |
6916 | 81 ## Documentation ## |
82 | |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
83 The Vim tutor is a one hour training course for beginners. Often it can be |
6916 | 84 started as `vimtutor`. See `:help tutor` for more information. |
85 | |
86 The best is to use `:help` in Vim. If you don't have an executable yet, read | |
87 `runtime/doc/help.txt`. It contains pointers to the other documentation | |
88 files. The User Manual reads like a book and is recommended to learn to use | |
89 Vim. See `:help user-manual`. | |
90 | |
91 | |
92 ## Copying ## | |
93 | |
94 Vim is Charityware. You can use and copy it as much as you like, but you are | |
95 encouraged to make a donation to help orphans in Uganda. Please read the file | |
96 `runtime/doc/uganda.txt` for details (do `:help uganda` inside Vim). | |
97 | |
98 Summary of the license: There are no restrictions on using or distributing an | |
99 unmodified copy of Vim. Parts of Vim may also be distributed, but the license | |
100 text must always be included. For modified versions a few restrictions apply. | |
101 The license is GPL compatible, you may compile Vim with GPL libraries and | |
102 distribute it. | |
103 | |
104 | |
105 ## Sponsoring ## | |
106 | |
107 Fixing bugs and adding new features takes a lot of time and effort. To show | |
108 your appreciation for the work and motivate Bram and others to continue | |
109 working on Vim please send a donation. | |
110 | |
111 Since Bram is back to a paid job the money will now be used to help children | |
112 in Uganda. See `runtime/doc/uganda.txt`. But at the same time donations | |
113 increase Bram's motivation to keep working on Vim! | |
114 | |
115 For the most recent information about sponsoring look on the Vim web site: | |
116 http://www.vim.org/sponsor/ | |
117 | |
118 | |
7127
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
119 ## Contributing ## |
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
120 |
7179
f7d6cc6b78b5
commit https://github.com/vim/vim/commit/f1a4c98ea6fa122ceb24c1ad17e184703cbfd182
Christian Brabandt <cb@256bit.org>
parents:
7177
diff
changeset
|
121 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
|
122 |
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
123 |
6916 | 124 ## Information ## |
125 | |
126 The latest news about Vim can be found on the Vim home page: | |
127 http://www.vim.org/ | |
128 | |
129 If you have problems, have a look at the Vim documentation or tips: | |
130 http://www.vim.org/docs.php | |
131 http://vim.wikia.com/wiki/Vim_Tips_Wiki | |
132 | |
133 If you still have problems or any other questions, use one of the mailing | |
134 lists to discuss them with Vim users and developers: | |
135 http://www.vim.org/maillist.php | |
136 | |
137 If nothing else works, report bugs directly: | |
138 Bram Moolenaar <Bram@vim.org> | |
139 | |
140 | |
141 ## Main author ## | |
142 | |
143 Send any other comments, patches, flowers and suggestions to: | |
144 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
|
145 |
b5b0b87f1a39
patch 8.1.0077: header of README file is not nice
Christian Brabandt <cb@256bit.org>
parents:
14115
diff
changeset
|
146 |
18879 | 147 This is `README.md` for version 8.2 of Vim: Vi IMproved. |
18664 | 148 |
149 | |
150 ## Translations of this README ## | |
151 | |
152 [Korean](https://github.com/cjw1359/opensource/blob/master/Vim/README_ko.md) |