Mercurial > vim
annotate README.md @ 12754:5707872d5c07 v8.0.1255
patch 8.0.1255: duplicate badge README file
commit https://github.com/vim/vim/commit/ea84df8041dbbff95acb1db8532281679c5fbe5a
Author: Bram Moolenaar <Bram@vim.org>
Date: Thu Nov 2 22:38:51 2017 +0100
patch 8.0.1255: duplicate badge README file
Problem: duplicate badge README file.
Solution: Remove one. (Dominique Pelle)
| author | Christian Brabandt <cb@256bit.org> |
|---|---|
| date | Thu, 02 Nov 2017 22:45:05 +0100 |
| parents | c7f587de22a1 |
| children | 1174611ad715 |
| 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. |
|
12740
c7f587de22a1
patch 8.0.1248: stray + in README file
Christian Brabandt <cb@256bit.org>
parents:
12738
diff
changeset
|
2 |
|
7177
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
7137
diff
changeset
|
3 [](https://travis-ci.org/vim/vim) |
|
11248
c12b80e3d323
patch 8.0.0510: typo in link to codecov.io results
Christian Brabandt <cb@256bit.org>
parents:
11246
diff
changeset
|
4 [](https://codecov.io/gh/vim/vim?branch=master) |
|
7177
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
7137
diff
changeset
|
5 [](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
|
6 [](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
|
7 [](https://scan.coverity.com/projects/vim) |
|
12754
5707872d5c07
patch 8.0.1255: duplicate badge README file
Christian Brabandt <cb@256bit.org>
parents:
12740
diff
changeset
|
8 [](https://buildd.debian.org/vim) |
| 6916 | 9 |
| 10 | |
|
7177
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
7137
diff
changeset
|
11 ## What is Vim? ## |
| 6916 | 12 |
|
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
13 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
|
14 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
|
15 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
|
16 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
|
17 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
|
18 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
|
19 Vi. |
| 6916 | 20 |
| 21 This editor is very useful for editing programs and other plain text files. | |
| 22 All commands are given with normal keyboard characters, so those who can type | |
| 23 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
|
24 mapped to commands by the user, and the mouse can be used. |
| 6916 | 25 |
|
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
26 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
|
27 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
|
28 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
|
29 DOS, Atari MiNT, BeOS, RISC OS and OS/2. These are no longer maintained. |
| 6916 | 30 |
| 31 | |
| 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: |
|
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
47 * 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
|
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 |
|
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
58 `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
|
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 |
|
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
64 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
|
65 archive): |
|
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 |
|
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
71 README_vms.txt VMS |
|
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
72 |
|
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
73 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
|
74 |
|
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
75 |
| 6916 | 76 ## Documentation ## |
| 77 | |
|
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
78 The Vim tutor is a one hour training course for beginners. Often it can be |
| 6916 | 79 started as `vimtutor`. See `:help tutor` for more information. |
| 80 | |
| 81 The best is to use `:help` in Vim. If you don't have an executable yet, read | |
| 82 `runtime/doc/help.txt`. It contains pointers to the other documentation | |
| 83 files. The User Manual reads like a book and is recommended to learn to use | |
| 84 Vim. See `:help user-manual`. | |
| 85 | |
| 86 | |
| 87 ## Copying ## | |
| 88 | |
| 89 Vim is Charityware. You can use and copy it as much as you like, but you are | |
| 90 encouraged to make a donation to help orphans in Uganda. Please read the file | |
| 91 `runtime/doc/uganda.txt` for details (do `:help uganda` inside Vim). | |
| 92 | |
| 93 Summary of the license: There are no restrictions on using or distributing an | |
| 94 unmodified copy of Vim. Parts of Vim may also be distributed, but the license | |
| 95 text must always be included. For modified versions a few restrictions apply. | |
| 96 The license is GPL compatible, you may compile Vim with GPL libraries and | |
| 97 distribute it. | |
| 98 | |
| 99 | |
| 100 ## Sponsoring ## | |
| 101 | |
| 102 Fixing bugs and adding new features takes a lot of time and effort. To show | |
| 103 your appreciation for the work and motivate Bram and others to continue | |
| 104 working on Vim please send a donation. | |
| 105 | |
| 106 Since Bram is back to a paid job the money will now be used to help children | |
| 107 in Uganda. See `runtime/doc/uganda.txt`. But at the same time donations | |
| 108 increase Bram's motivation to keep working on Vim! | |
| 109 | |
| 110 For the most recent information about sponsoring look on the Vim web site: | |
| 111 http://www.vim.org/sponsor/ | |
| 112 | |
| 113 | |
|
7127
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
114 ## Contributing ## |
|
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
115 |
|
7179
f7d6cc6b78b5
commit https://github.com/vim/vim/commit/f1a4c98ea6fa122ceb24c1ad17e184703cbfd182
Christian Brabandt <cb@256bit.org>
parents:
7177
diff
changeset
|
116 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
|
117 |
|
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
118 |
| 6916 | 119 ## Information ## |
| 120 | |
| 121 The latest news about Vim can be found on the Vim home page: | |
| 122 http://www.vim.org/ | |
| 123 | |
| 124 If you have problems, have a look at the Vim documentation or tips: | |
| 125 http://www.vim.org/docs.php | |
| 126 http://vim.wikia.com/wiki/Vim_Tips_Wiki | |
| 127 | |
| 128 If you still have problems or any other questions, use one of the mailing | |
| 129 lists to discuss them with Vim users and developers: | |
| 130 http://www.vim.org/maillist.php | |
| 131 | |
| 132 If nothing else works, report bugs directly: | |
| 133 Bram Moolenaar <Bram@vim.org> | |
| 134 | |
| 135 | |
| 136 ## Main author ## | |
| 137 | |
| 138 Send any other comments, patches, flowers and suggestions to: | |
| 139 Bram Moolenaar <Bram@vim.org> |