annotate README.md @ 8665:7a2346148551 v7.4.1622

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