Mercurial > vim
annotate README.md @ 7177:c4d677c50b9b v7.4.899
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Author: Bram Moolenaar <Bram@vim.org>
Date: Sun Oct 25 13:55:00 2015 +0100
patch 7.4.899
Problem: README file is not optimal.
Solution: Move buttons, update some text. (closes #460)
author | Christian Brabandt <cb@256bit.org> |
---|---|
date | Sun, 25 Oct 2015 14:00:04 +0100 |
parents | 41896b9720cc |
children | f7d6cc6b78b5 |
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 [![Build Status](https://travis-ci.org/vim/vim.svg?branch=master)](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 [![Coverage Status](https://coveralls.io/repos/vim/vim/badge.svg?branch=master&service=github)](https://coveralls.io/github/vim/vim?branch=master) |
6916 | 4 |
5 | |
7177
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
7137
diff
changeset
|
6 ## What is Vim? ## |
6916 | 7 |
8 Vim is an almost compatible version of the UNIX editor Vi. Many new features | |
9 have been added: multi-level undo, syntax highlighting, command line history, | |
10 on-line help, spell checking, filename completion, block operations, etc. | |
11 There is also a Graphical User Interface (GUI) available. See | |
12 `runtime/doc/vi_diff.txt` for differences with Vi. | |
13 | |
14 This editor is very useful for editing programs and other plain text files. | |
15 All commands are given with normal keyboard characters, so those who can type | |
16 with ten fingers can work very fast. Additionally, function keys can be | |
17 defined by the user, and the mouse can be used. | |
18 | |
19 Vim runs under Amiga DOS, MS-DOS, MS-Windows (95, 98, Me, NT, 2000, XP, Vista, | |
20 7), Atari MiNT, Macintosh, BeOS, VMS, RISC OS, OS/2 and almost all flavours of | |
21 UNIX. Porting to other systems should not be very difficult. | |
22 | |
23 | |
24 ## Distribution ## | |
25 | |
7177
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
7137
diff
changeset
|
26 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
|
27 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
|
28 if you want more features. |
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
7137
diff
changeset
|
29 |
6916 | 30 There are separate distributions for Unix, PC, Amiga and some other systems. |
31 This `README.md` file comes with the runtime archive. It includes the | |
32 documentation, syntax files and other files that are used at runtime. To run | |
33 Vim you must get either one of the binary archives or a source archive. | |
34 Which one you need depends on the system you want to run it on and whether you | |
35 want or must compile it yourself. Check http://www.vim.org/download.php for | |
36 an overview of currently available distributions. | |
37 | |
38 | |
39 ## Documentation ## | |
40 | |
41 The vim tutor is a one hour training course for beginners. Mostly it can be | |
42 started as `vimtutor`. See `:help tutor` for more information. | |
43 | |
44 The best is to use `:help` in Vim. If you don't have an executable yet, read | |
45 `runtime/doc/help.txt`. It contains pointers to the other documentation | |
46 files. The User Manual reads like a book and is recommended to learn to use | |
47 Vim. See `:help user-manual`. | |
48 | |
49 | |
50 ## Copying ## | |
51 | |
52 Vim is Charityware. You can use and copy it as much as you like, but you are | |
53 encouraged to make a donation to help orphans in Uganda. Please read the file | |
54 `runtime/doc/uganda.txt` for details (do `:help uganda` inside Vim). | |
55 | |
56 Summary of the license: There are no restrictions on using or distributing an | |
57 unmodified copy of Vim. Parts of Vim may also be distributed, but the license | |
58 text must always be included. For modified versions a few restrictions apply. | |
59 The license is GPL compatible, you may compile Vim with GPL libraries and | |
60 distribute it. | |
61 | |
62 | |
63 ## Sponsoring ## | |
64 | |
65 Fixing bugs and adding new features takes a lot of time and effort. To show | |
66 your appreciation for the work and motivate Bram and others to continue | |
67 working on Vim please send a donation. | |
68 | |
69 Since Bram is back to a paid job the money will now be used to help children | |
70 in Uganda. See `runtime/doc/uganda.txt`. But at the same time donations | |
71 increase Bram's motivation to keep working on Vim! | |
72 | |
73 For the most recent information about sponsoring look on the Vim web site: | |
74 http://www.vim.org/sponsor/ | |
75 | |
76 | |
77 ## Compiling ## | |
78 | |
79 If you obtained a binary distribution you don't need to compile Vim. If you | |
80 obtained a source distribution, all the stuff for compiling Vim is in the | |
81 `src` directory. See `src/INSTALL` for instructions. | |
82 | |
83 | |
84 ## Installation ## | |
85 | |
86 See one of these files for system-specific instructions: | |
87 | |
88 README_ami.txt Amiga | |
89 README_unix.txt Unix | |
90 README_dos.txt MS-DOS and MS-Windows | |
91 README_os2.txt OS/2 | |
92 README_mac.txt Macintosh | |
93 README_vms.txt VMS | |
94 | |
95 There are more `README_*.txt` files, depending on the distribution you used. | |
96 | |
97 | |
7127
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
98 ## Contributing ## |
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
99 |
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
100 If you would like to help making Vim better, see the `CONTRIBUTING.md` file. |
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
101 |
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
102 |
6916 | 103 ## Information ## |
104 | |
105 The latest news about Vim can be found on the Vim home page: | |
106 http://www.vim.org/ | |
107 | |
108 If you have problems, have a look at the Vim documentation or tips: | |
109 http://www.vim.org/docs.php | |
110 http://vim.wikia.com/wiki/Vim_Tips_Wiki | |
111 | |
112 If you still have problems or any other questions, use one of the mailing | |
113 lists to discuss them with Vim users and developers: | |
114 http://www.vim.org/maillist.php | |
115 | |
116 If nothing else works, report bugs directly: | |
117 Bram Moolenaar <Bram@vim.org> | |
118 | |
119 | |
120 ## Main author ## | |
121 | |
122 Send any other comments, patches, flowers and suggestions to: | |
123 Bram Moolenaar <Bram@vim.org> |