Mercurial > vim
annotate README.md @ 24605:f5484f767f70
Added tag v8.2.2841 for changeset b1ba40ea418db306aedb384ce66405b83d83e399
author | Bram Moolenaar <Bram@vim.org> |
---|---|
date | Fri, 07 May 2021 15:15:05 +0200 |
parents | 9f41bfdbc6fc |
children | e73a9667e471 |
rev | line source |
---|---|
23324
863683061a02
Attempt to align the logo without a markdown table.
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
1 [![Vim Logo](https://github.com/vim/vim/raw/master/runtime/vimlogo.gif)](https://www.vim.org) |
23327 | 2 |
23462
666119b42a8c
patch 8.2.2274: badge for Travis is outdated
Bram Moolenaar <Bram@vim.org>
parents:
23327
diff
changeset
|
3 [![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) [![Travis Build Status](https://travis-ci.com/vim/vim.svg?branch=master)](https://travis-ci.com/github/vim/vim) [![Appveyor Build status](https://ci.appveyor.com/api/projects/status/o2qht2kjm02sgghk?svg=true)](https://ci.appveyor.com/project/chrisbra/vim) [![Cirrus Build Status](https://api.cirrus-ci.com/github/vim/vim.svg)](https://cirrus-ci.com/github/vim/vim) [![Coverage Status](https://codecov.io/gh/vim/vim/coverage.svg?branch=master)](https://codecov.io/gh/vim/vim?branch=master) [![Coverity Scan](https://scan.coverity.com/projects/241/badge.svg)](https://scan.coverity.com/projects/vim) [![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) [![Debian CI](https://badges.debian.net/badges/debian/testing/vim/version.svg)](https://buildd.debian.org/vim) [![Packages](https://repology.org/badge/tiny-repos/vim.svg)](https://repology.org/metapackage/vim) [![Fossies codespell report](https://fossies.org/linux/test/vim-master.tar.gz/codespell.svg)](https://fossies.org/linux/test/vim-master.tar.gz/codespell.html) |
23324
863683061a02
Attempt to align the logo without a markdown table.
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
4 |
23327 | 5 <sub>For translations of this README see the end.</sub> |
6916 | 6 |
7 | |
7177
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
7137
diff
changeset
|
8 ## What is Vim? ## |
6916 | 9 |
24468 | 10 Vim is a greatly improved version of the good old UNIX editor |
11 [Vi](https://en.wikipedia.org/wiki/Vi). Many new | |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
12 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
|
13 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
|
14 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
|
15 available. Still, Vi compatibility is maintained, those who have Vi "in the |
24468 | 16 fingers" will feel at home. |
17 See [`runtime/doc/vi_diff.txt`](runtime/doc/vi_diff.txt) for differences with | |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
18 Vi. |
6916 | 19 |
20 This editor is very useful for editing programs and other plain text files. | |
21 All commands are given with normal keyboard characters, so those who can type | |
22 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
|
23 mapped to commands by the user, and the mouse can be used. |
6916 | 24 |
20134
352701a626ed
patch 8.2.0622: Haiku: GUI does not compile
Bram Moolenaar <Bram@vim.org>
parents:
19181
diff
changeset
|
25 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
|
26 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
|
27 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
|
28 Atari MiNT, BeOS, RISC OS and OS/2. These are no longer maintained. |
6916 | 29 |
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19125
diff
changeset
|
30 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
|
31 |
6916 | 32 ## Distribution ## |
33 | |
7177
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
7137
diff
changeset
|
34 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
|
35 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
|
36 if you want more features. |
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
7137
diff
changeset
|
37 |
6916 | 38 There are separate distributions for Unix, PC, Amiga and some other systems. |
39 This `README.md` file comes with the runtime archive. It includes the | |
40 documentation, syntax files and other files that are used at runtime. To run | |
41 Vim you must get either one of the binary archives or a source archive. | |
42 Which one you need depends on the system you want to run it on and whether you | |
43 want or must compile it yourself. Check http://www.vim.org/download.php for | |
44 an overview of currently available distributions. | |
45 | |
8917
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
46 Some popular places to get the latest Vim: |
24468 | 47 * Check out the git repository from [GitHub](https://github.com/vim/vim). |
8917
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
48 * 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
|
49 * Get a Windows executable from the |
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
50 [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
|
51 |
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
52 |
6916 | 53 |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
54 ## Compiling ## |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
55 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
56 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
|
57 obtained a source distribution, all the stuff for compiling Vim is in the |
24468 | 58 [`src`](/src) directory. See [`src/INSTALL`](src/INSTALL) for instructions. |
8791
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 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
61 ## Installation ## |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
62 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
63 See one of these files for system-specific instructions. Either in the |
24468 | 64 [READMEdir directory](./READMEdir/) (in the repository) or |
65 the top directory (if you unpack an archive): | |
8791
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 README_ami.txt Amiga |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
68 README_unix.txt Unix |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
69 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
|
70 README_mac.txt Macintosh |
20134
352701a626ed
patch 8.2.0622: Haiku: GUI does not compile
Bram Moolenaar <Bram@vim.org>
parents:
19181
diff
changeset
|
71 README_haiku.txt Haiku |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
72 README_vms.txt VMS |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
73 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
74 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
|
75 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
76 |
6916 | 77 ## Documentation ## |
78 | |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
79 The Vim tutor is a one hour training course for beginners. Often it can be |
6916 | 80 started as `vimtutor`. See `:help tutor` for more information. |
81 | |
82 The best is to use `:help` in Vim. If you don't have an executable yet, read | |
24468 | 83 [`runtime/doc/help.txt`](/runtime/doc/help.txt). |
84 It contains pointers to the other documentation files. | |
85 The User Manual reads like a book and is recommended to learn to use | |
6916 | 86 Vim. See `:help user-manual`. |
87 | |
88 | |
89 ## Copying ## | |
90 | |
91 Vim is Charityware. You can use and copy it as much as you like, but you are | |
92 encouraged to make a donation to help orphans in Uganda. Please read the file | |
24468 | 93 [`runtime/doc/uganda.txt`](runtime/doc/uganda.txt) |
94 for details (do `:help uganda` inside Vim). | |
6916 | 95 |
96 Summary of the license: There are no restrictions on using or distributing an | |
97 unmodified copy of Vim. Parts of Vim may also be distributed, but the license | |
98 text must always be included. For modified versions a few restrictions apply. | |
99 The license is GPL compatible, you may compile Vim with GPL libraries and | |
100 distribute it. | |
101 | |
102 | |
103 ## Sponsoring ## | |
104 | |
105 Fixing bugs and adding new features takes a lot of time and effort. To show | |
106 your appreciation for the work and motivate Bram and others to continue | |
107 working on Vim please send a donation. | |
108 | |
109 Since Bram is back to a paid job the money will now be used to help children | |
24468 | 110 in Uganda. See [`runtime/doc/uganda.txt`](runtime/doc/uganda.txt). But |
111 at the same time donations increase Bram's motivation to keep working on Vim! | |
6916 | 112 |
113 For the most recent information about sponsoring look on the Vim web site: | |
114 http://www.vim.org/sponsor/ | |
115 | |
116 | |
7127
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
117 ## Contributing ## |
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
118 |
24468 | 119 If you would like to help making Vim better, see the |
120 [CONTRIBUTING.md](/CONTRIBUTING.md) file. | |
7127
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
121 |
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
122 |
6916 | 123 ## Information ## |
124 | |
125 The latest news about Vim can be found on the Vim home page: | |
126 http://www.vim.org/ | |
127 | |
128 If you have problems, have a look at the Vim documentation or tips: | |
129 http://www.vim.org/docs.php | |
130 http://vim.wikia.com/wiki/Vim_Tips_Wiki | |
131 | |
132 If you still have problems or any other questions, use one of the mailing | |
133 lists to discuss them with Vim users and developers: | |
134 http://www.vim.org/maillist.php | |
135 | |
136 If nothing else works, report bugs directly: | |
137 Bram Moolenaar <Bram@vim.org> | |
138 | |
139 | |
140 ## Main author ## | |
141 | |
142 Send any other comments, patches, flowers and suggestions to: | |
143 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
|
144 |
b5b0b87f1a39
patch 8.1.0077: header of README file is not nice
Christian Brabandt <cb@256bit.org>
parents:
14115
diff
changeset
|
145 |
18879 | 146 This is `README.md` for version 8.2 of Vim: Vi IMproved. |
18664 | 147 |
148 | |
149 ## Translations of this README ## | |
150 | |
151 [Korean](https://github.com/cjw1359/opensource/blob/master/Vim/README_ko.md) |