Mercurial > vim
annotate README.md @ 8791:43b5ff7837ea v7.4.1684
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Author: Bram Moolenaar <Bram@vim.org>
Date: Tue Mar 29 22:29:18 2016 +0200
patch 7.4.1684
Problem: README text is slightly outdated.
Solution: Mention the READMEdir directory.
| author | Christian Brabandt <cb@256bit.org> |
|---|---|
| date | Tue, 29 Mar 2016 22:30:09 +0200 |
| parents | 5c9603b1084d |
| children | d07e51166f08 |
| rev | line source |
|---|---|
| 6916 | 1 `README.md` for version 7.4 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 | |
| 43 | |
|
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
44 ## Compiling ## |
|
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
45 |
|
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
46 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
|
47 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
|
48 `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
|
49 |
|
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
50 |
|
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
51 ## Installation ## |
|
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 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
|
54 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
|
55 archive): |
|
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 README_ami.txt Amiga |
|
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
58 README_unix.txt Unix |
|
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
59 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
|
60 README_mac.txt Macintosh |
|
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
61 README_vms.txt VMS |
|
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 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
|
64 |
|
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
65 |
| 6916 | 66 ## Documentation ## |
| 67 | |
|
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
68 The Vim tutor is a one hour training course for beginners. Often it can be |
| 6916 | 69 started as `vimtutor`. See `:help tutor` for more information. |
| 70 | |
| 71 The best is to use `:help` in Vim. If you don't have an executable yet, read | |
| 72 `runtime/doc/help.txt`. It contains pointers to the other documentation | |
| 73 files. The User Manual reads like a book and is recommended to learn to use | |
| 74 Vim. See `:help user-manual`. | |
| 75 | |
| 76 | |
| 77 ## Copying ## | |
| 78 | |
| 79 Vim is Charityware. You can use and copy it as much as you like, but you are | |
| 80 encouraged to make a donation to help orphans in Uganda. Please read the file | |
| 81 `runtime/doc/uganda.txt` for details (do `:help uganda` inside Vim). | |
| 82 | |
| 83 Summary of the license: There are no restrictions on using or distributing an | |
| 84 unmodified copy of Vim. Parts of Vim may also be distributed, but the license | |
| 85 text must always be included. For modified versions a few restrictions apply. | |
| 86 The license is GPL compatible, you may compile Vim with GPL libraries and | |
| 87 distribute it. | |
| 88 | |
| 89 | |
| 90 ## Sponsoring ## | |
| 91 | |
| 92 Fixing bugs and adding new features takes a lot of time and effort. To show | |
| 93 your appreciation for the work and motivate Bram and others to continue | |
| 94 working on Vim please send a donation. | |
| 95 | |
| 96 Since Bram is back to a paid job the money will now be used to help children | |
| 97 in Uganda. See `runtime/doc/uganda.txt`. But at the same time donations | |
| 98 increase Bram's motivation to keep working on Vim! | |
| 99 | |
| 100 For the most recent information about sponsoring look on the Vim web site: | |
| 101 http://www.vim.org/sponsor/ | |
| 102 | |
| 103 | |
|
7127
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
104 ## Contributing ## |
|
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
105 |
|
7179
f7d6cc6b78b5
commit https://github.com/vim/vim/commit/f1a4c98ea6fa122ceb24c1ad17e184703cbfd182
Christian Brabandt <cb@256bit.org>
parents:
7177
diff
changeset
|
106 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
|
107 |
|
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
108 |
| 6916 | 109 ## Information ## |
| 110 | |
| 111 The latest news about Vim can be found on the Vim home page: | |
| 112 http://www.vim.org/ | |
| 113 | |
| 114 If you have problems, have a look at the Vim documentation or tips: | |
| 115 http://www.vim.org/docs.php | |
| 116 http://vim.wikia.com/wiki/Vim_Tips_Wiki | |
| 117 | |
| 118 If you still have problems or any other questions, use one of the mailing | |
| 119 lists to discuss them with Vim users and developers: | |
| 120 http://www.vim.org/maillist.php | |
| 121 | |
| 122 If nothing else works, report bugs directly: | |
| 123 Bram Moolenaar <Bram@vim.org> | |
| 124 | |
| 125 | |
| 126 ## Main author ## | |
| 127 | |
| 128 Send any other comments, patches, flowers and suggestions to: | |
| 129 Bram Moolenaar <Bram@vim.org> |