Mercurial > vim
annotate README.md @ 10919:7fccaa0156b6
Added tag v8.0.0348 for changeset a0c2c6d51b1aedc86df4b7f565cc5117f7ae389c
| author | Christian Brabandt <cb@256bit.org> |
|---|---|
| date | Wed, 22 Feb 2017 22:15:05 +0100 |
| parents | 9f48eab77d62 |
| children | 166d1de0ba9d |
| rev | line source |
|---|---|
|
10198
9f48eab77d62
commit https://github.com/vim/vim/commit/bb76f24af2010943387ce696a7092175b4ecccf2
Christian Brabandt <cb@256bit.org>
parents:
8917
diff
changeset
|
1 `README.md` for version 8.0 of Vim: Vi IMproved. |
|
7177
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
7137
diff
changeset
|
2 [](https://travis-ci.org/vim/vim) |
|
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
7137
diff
changeset
|
3 [](https://coveralls.io/github/vim/vim?branch=master) |
|
7179
f7d6cc6b78b5
commit https://github.com/vim/vim/commit/f1a4c98ea6fa122ceb24c1ad17e184703cbfd182
Christian Brabandt <cb@256bit.org>
parents:
7177
diff
changeset
|
4 [](https://ci.appveyor.com/project/chrisbra/vim) |
|
8619
5c9603b1084d
commit https://github.com/vim/vim/commit/8a82c7fa5ec55b59782f7a7846d6152ccf3a22c7
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
5 [](https://scan.coverity.com/projects/vim) |
| 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 |
|
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
10 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
|
11 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
|
12 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
|
13 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
|
14 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
|
15 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
|
16 Vi. |
| 6916 | 17 |
| 18 This editor is very useful for editing programs and other plain text files. | |
| 19 All commands are given with normal keyboard characters, so those who can type | |
| 20 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
|
21 mapped to commands by the user, and the mouse can be used. |
| 6916 | 22 |
|
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
23 Vim runs under MS-Windows (NT, 2000, XP, Vista, 7, 8, 10), Macintosh, VMS and |
|
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
24 almost all flavours of UNIX. Porting to other systems should not be very |
|
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
25 difficult. Older versions of Vim run on MS-DOS, MS-Windows 95/98/Me, Amiga |
|
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
26 DOS, Atari MiNT, BeOS, RISC OS and OS/2. These are no longer maintained. |
| 6916 | 27 |
| 28 | |
| 29 ## Distribution ## | |
| 30 | |
|
7177
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
7137
diff
changeset
|
31 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
|
32 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
|
33 if you want more features. |
|
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
7137
diff
changeset
|
34 |
| 6916 | 35 There are separate distributions for Unix, PC, Amiga and some other systems. |
| 36 This `README.md` file comes with the runtime archive. It includes the | |
| 37 documentation, syntax files and other files that are used at runtime. To run | |
| 38 Vim you must get either one of the binary archives or a source archive. | |
| 39 Which one you need depends on the system you want to run it on and whether you | |
| 40 want or must compile it yourself. Check http://www.vim.org/download.php for | |
| 41 an overview of currently available distributions. | |
| 42 | |
|
8917
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
43 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
|
44 * 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
|
45 * 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
|
46 * Get a Windows executable from the |
|
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
47 [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
|
48 |
|
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
49 |
| 6916 | 50 |
|
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
51 ## Compiling ## |
|
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
52 |
|
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
53 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
|
54 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
|
55 `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
|
56 |
|
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
57 |
|
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
58 ## Installation ## |
|
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 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
|
61 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
|
62 archive): |
|
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 README_ami.txt Amiga |
|
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
65 README_unix.txt Unix |
|
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
66 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
|
67 README_mac.txt Macintosh |
|
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
68 README_vms.txt VMS |
|
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
69 |
|
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
70 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
|
71 |
|
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
72 |
| 6916 | 73 ## Documentation ## |
| 74 | |
|
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
75 The Vim tutor is a one hour training course for beginners. Often it can be |
| 6916 | 76 started as `vimtutor`. See `:help tutor` for more information. |
| 77 | |
| 78 The best is to use `:help` in Vim. If you don't have an executable yet, read | |
| 79 `runtime/doc/help.txt`. It contains pointers to the other documentation | |
| 80 files. The User Manual reads like a book and is recommended to learn to use | |
| 81 Vim. See `:help user-manual`. | |
| 82 | |
| 83 | |
| 84 ## Copying ## | |
| 85 | |
| 86 Vim is Charityware. You can use and copy it as much as you like, but you are | |
| 87 encouraged to make a donation to help orphans in Uganda. Please read the file | |
| 88 `runtime/doc/uganda.txt` for details (do `:help uganda` inside Vim). | |
| 89 | |
| 90 Summary of the license: There are no restrictions on using or distributing an | |
| 91 unmodified copy of Vim. Parts of Vim may also be distributed, but the license | |
| 92 text must always be included. For modified versions a few restrictions apply. | |
| 93 The license is GPL compatible, you may compile Vim with GPL libraries and | |
| 94 distribute it. | |
| 95 | |
| 96 | |
| 97 ## Sponsoring ## | |
| 98 | |
| 99 Fixing bugs and adding new features takes a lot of time and effort. To show | |
| 100 your appreciation for the work and motivate Bram and others to continue | |
| 101 working on Vim please send a donation. | |
| 102 | |
| 103 Since Bram is back to a paid job the money will now be used to help children | |
| 104 in Uganda. See `runtime/doc/uganda.txt`. But at the same time donations | |
| 105 increase Bram's motivation to keep working on Vim! | |
| 106 | |
| 107 For the most recent information about sponsoring look on the Vim web site: | |
| 108 http://www.vim.org/sponsor/ | |
| 109 | |
| 110 | |
|
7127
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
111 ## Contributing ## |
|
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
112 |
|
7179
f7d6cc6b78b5
commit https://github.com/vim/vim/commit/f1a4c98ea6fa122ceb24c1ad17e184703cbfd182
Christian Brabandt <cb@256bit.org>
parents:
7177
diff
changeset
|
113 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
|
114 |
|
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
115 |
| 6916 | 116 ## Information ## |
| 117 | |
| 118 The latest news about Vim can be found on the Vim home page: | |
| 119 http://www.vim.org/ | |
| 120 | |
| 121 If you have problems, have a look at the Vim documentation or tips: | |
| 122 http://www.vim.org/docs.php | |
| 123 http://vim.wikia.com/wiki/Vim_Tips_Wiki | |
| 124 | |
| 125 If you still have problems or any other questions, use one of the mailing | |
| 126 lists to discuss them with Vim users and developers: | |
| 127 http://www.vim.org/maillist.php | |
| 128 | |
| 129 If nothing else works, report bugs directly: | |
| 130 Bram Moolenaar <Bram@vim.org> | |
| 131 | |
| 132 | |
| 133 ## Main author ## | |
| 134 | |
| 135 Send any other comments, patches, flowers and suggestions to: | |
| 136 Bram Moolenaar <Bram@vim.org> |