Mercurial > vim

comparison README.md @ 8791:43b5ff7837ea v7.4.1684

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
8790:42f09c7a3597 8791:43b5ff7837ea
5 [![Coverity Scan](https://scan.coverity.com/projects/241/badge.svg)](https://scan.coverity.com/projects/vim) 5 [![Coverity Scan](https://scan.coverity.com/projects/241/badge.svg)](https://scan.coverity.com/projects/vim)
6 6
7 7
8 ## What is Vim? ## 8 ## What is Vim? ##
9 9
10 Vim is an almost compatible version of the UNIX editor Vi. Many new features 10 Vim is a greatly improved version of the good old UNIX editor Vi. Many new
11 have been added: multi-level undo, syntax highlighting, command line history, 11 features have been added: multi-level undo, syntax highlighting, command line
12 on-line help, spell checking, filename completion, block operations, etc. 12 history, on-line help, spell checking, filename completion, block operations,
13 There is also a Graphical User Interface (GUI) available. See 13 script language, etc. There is also a Graphical User Interface (GUI)
14 `runtime/doc/vi_diff.txt` for differences with Vi. 14 available. Still, Vi compatibility is maintained, those who have Vi "in the
15 fingers" will feel at home. See `runtime/doc/vi_diff.txt` for differences with
16 Vi.
15 17
16 This editor is very useful for editing programs and other plain text files. 18 This editor is very useful for editing programs and other plain text files.
17 All commands are given with normal keyboard characters, so those who can type 19 All commands are given with normal keyboard characters, so those who can type
18 with ten fingers can work very fast. Additionally, function keys can be 20 with ten fingers can work very fast. Additionally, function keys can be
19 defined by the user, and the mouse can be used. 21 mapped to commands by the user, and the mouse can be used.
20 22
21 Vim runs under MS-DOS, MS-Windows (NT, 2000, XP, Vista, 7, 8, 10), Macintosh, 23 Vim runs under MS-Windows (NT, 2000, XP, Vista, 7, 8, 10), Macintosh, VMS and
22 VMS and almost all flavours of UNIX. Porting to other systems should not be 24 almost all flavours of UNIX. Porting to other systems should not be very
23 very difficult. Older versions of Vim run on MS-Windows 95/98/Me, Amiga DOS, 25 difficult. Older versions of Vim run on MS-DOS, MS-Windows 95/98/Me, Amiga
24 Atari MiNT, BeOS, RISC OS and OS/2. These are no longer maintained. 26 DOS, Atari MiNT, BeOS, RISC OS and OS/2. These are no longer maintained.
25 27
26 28
27 ## Distribution ## 29 ## Distribution ##
28 30
29 You can often use your favorite package manager to install Vim. On Mac and 31 You can often use your favorite package manager to install Vim. On Mac and
37 Which one you need depends on the system you want to run it on and whether you 39 Which one you need depends on the system you want to run it on and whether you
38 want or must compile it yourself. Check http://www.vim.org/download.php for 40 want or must compile it yourself. Check http://www.vim.org/download.php for
39 an overview of currently available distributions. 41 an overview of currently available distributions.
40 42
41 43
44 ## Compiling ##
45
46 If you obtained a binary distribution you don't need to compile Vim. If you
47 obtained a source distribution, all the stuff for compiling Vim is in the
48 `src` directory. See `src/INSTALL` for instructions.
49
50
51 ## Installation ##
52
53 See one of these files for system-specific instructions. Either in the
54 READMEdir directory (in the repository) or the top directory (if you unpack an
55 archive):
56
57 README_ami.txt Amiga
58 README_unix.txt Unix
59 README_dos.txt MS-DOS and MS-Windows
60 README_mac.txt Macintosh
61 README_vms.txt VMS
62
63 There are other `README_*.txt` files, depending on the distribution you used.
64
65
42 ## Documentation ## 66 ## Documentation ##
43 67
44 The vim tutor is a one hour training course for beginners. Mostly it can be 68 The Vim tutor is a one hour training course for beginners. Often it can be
45 started as `vimtutor`. See `:help tutor` for more information. 69 started as `vimtutor`. See `:help tutor` for more information.
46 70
47 The best is to use `:help` in Vim. If you don't have an executable yet, read 71 The best is to use `:help` in Vim. If you don't have an executable yet, read
48 `runtime/doc/help.txt`. It contains pointers to the other documentation 72 `runtime/doc/help.txt`. It contains pointers to the other documentation
49 files. The User Manual reads like a book and is recommended to learn to use 73 files. The User Manual reads like a book and is recommended to learn to use
75 99
76 For the most recent information about sponsoring look on the Vim web site: 100 For the most recent information about sponsoring look on the Vim web site:
77 http://www.vim.org/sponsor/ 101 http://www.vim.org/sponsor/
78 102
79 103
80 ## Compiling ##
81
82 If you obtained a binary distribution you don't need to compile Vim. If you
83 obtained a source distribution, all the stuff for compiling Vim is in the
84 `src` directory. See `src/INSTALL` for instructions.
85
86
87 ## Installation ##
88
89 See one of these files for system-specific instructions:
90
91 README_ami.txt Amiga
92 README_unix.txt Unix
93 README_dos.txt MS-DOS and MS-Windows
94 README_mac.txt Macintosh
95 README_vms.txt VMS
96
97 There are more `README_*.txt` files, depending on the distribution you used.
98
99
100 ## Contributing ## 104 ## Contributing ##
101 105
102 If you would like to help making Vim better, see the [CONTRIBUTING.md](https://github.com/vim/vim/blob/master/CONTRIBUTING.md) file. 106 If you would like to help making Vim better, see the [CONTRIBUTING.md](https://github.com/vim/vim/blob/master/CONTRIBUTING.md) file.
103 107
104 108