Mercurial > vim
annotate README.md @ 19129:d7664581988e v8.2.0124
patch 8.2.0124: compiler warnings for variable types
Commit: https://github.com/vim/vim/commit/109ef128bd6efc8e1fb91a2a51357fcb19897698
Author: Bram Moolenaar <Bram@vim.org>
Date: Fri Jan 17 19:12:03 2020 +0100
patch 8.2.0124: compiler warnings for variable types
Problem: Compiler warnings for variable types.
Solution: Change type, add type cast. (Mike Williams)
author | Bram Moolenaar <Bram@vim.org> |
---|---|
date | Fri, 17 Jan 2020 19:15:04 +0100 |
parents | 286aa7c0c9ab |
children | 94eda51ba9ba |
rev | line source |
---|---|
14115
172ccc083d4a
patch 8.1.0075: no Vim logo in README file
Christian Brabandt <cb@256bit.org>
parents:
13963
diff
changeset
|
1 ![Vim Logo](https://github.com/vim/vim/blob/master/runtime/vimlogo.gif) |
172ccc083d4a
patch 8.1.0075: no Vim logo in README file
Christian Brabandt <cb@256bit.org>
parents:
13963
diff
changeset
|
2 |
18728
9f1cf1458708
patch 8.1.2354: Cirrus CI runs on another repository
Bram Moolenaar <Bram@vim.org>
parents:
18724
diff
changeset
|
3 [![Travis Build Status](https://travis-ci.org/vim/vim.svg?branch=master)](https://travis-ci.org/vim/vim) |
15879
ab5ee4f15e8e
patch 8.1.0946: Coveralls is not very useful
Bram Moolenaar <Bram@vim.org>
parents:
14746
diff
changeset
|
4 [![Appveyor Build status](https://ci.appveyor.com/api/projects/status/o2qht2kjm02sgghk?svg=true)](https://ci.appveyor.com/project/chrisbra/vim) |
18728
9f1cf1458708
patch 8.1.2354: Cirrus CI runs on another repository
Bram Moolenaar <Bram@vim.org>
parents:
18724
diff
changeset
|
5 [![Cirrus Build Status](https://api.cirrus-ci.com/github/vim/vim.svg)](https://cirrus-ci.com/github/vim/vim) |
11248
c12b80e3d323
patch 8.0.0510: typo in link to codecov.io results
Christian Brabandt <cb@256bit.org>
parents:
11246
diff
changeset
|
6 [![Coverage Status](https://codecov.io/gh/vim/vim/coverage.svg?branch=master)](https://codecov.io/gh/vim/vim?branch=master) |
8619
5c9603b1084d
commit https://github.com/vim/vim/commit/8a82c7fa5ec55b59782f7a7846d6152ccf3a22c7
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
7 [![Coverity Scan](https://scan.coverity.com/projects/241/badge.svg)](https://scan.coverity.com/projects/vim) |
14493
85c085bae335
patch 8.1.0260: no LGTM logo in README file
Christian Brabandt <cb@256bit.org>
parents:
14119
diff
changeset
|
8 [![Language Grade: C/C++](https://img.shields.io/lgtm/grade/cpp/g/vim/vim.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/vim/vim/context:cpp) |
12754
5707872d5c07
patch 8.0.1255: duplicate badge README file
Christian Brabandt <cb@256bit.org>
parents:
12740
diff
changeset
|
9 [![Debian CI](https://badges.debian.net/badges/debian/testing/vim/version.svg)](https://buildd.debian.org/vim) |
15879
ab5ee4f15e8e
patch 8.1.0946: Coveralls is not very useful
Bram Moolenaar <Bram@vim.org>
parents:
14746
diff
changeset
|
10 [![Packages](https://repology.org/badge/tiny-repos/vim.svg)](https://repology.org/metapackage/vim) |
18664 | 11 For translations of this README see the end. |
6916 | 12 |
13 | |
7177
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
7137
diff
changeset
|
14 ## What is Vim? ## |
6916 | 15 |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
16 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
|
17 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
|
18 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
|
19 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
|
20 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
|
21 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
|
22 Vi. |
6916 | 23 |
24 This editor is very useful for editing programs and other plain text files. | |
25 All commands are given with normal keyboard characters, so those who can type | |
26 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
|
27 mapped to commands by the user, and the mouse can be used. |
6916 | 28 |
19125
286aa7c0c9ab
patch 8.2.0122: readme files still mention MS-DOS
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
29 Vim runs under MS-Windows (XP, Vista, 7, 8, 10), macOS, VMS and almost all |
286aa7c0c9ab
patch 8.2.0122: readme files still mention MS-DOS
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
30 flavours of UNIX. Porting to other systems should not be very difficult. |
286aa7c0c9ab
patch 8.2.0122: readme files still mention MS-DOS
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
31 Older versions of Vim run on MS-DOS, MS-Windows 95/98/Me/NT/2000, Amiga DOS, |
286aa7c0c9ab
patch 8.2.0122: readme files still mention MS-DOS
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
32 Atari MiNT, BeOS, RISC OS and OS/2. These are no longer maintained. |
6916 | 33 |
34 ## Distribution ## | |
35 | |
7177
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
7137
diff
changeset
|
36 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
|
37 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
|
38 if you want more features. |
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
7137
diff
changeset
|
39 |
6916 | 40 There are separate distributions for Unix, PC, Amiga and some other systems. |
41 This `README.md` file comes with the runtime archive. It includes the | |
42 documentation, syntax files and other files that are used at runtime. To run | |
43 Vim you must get either one of the binary archives or a source archive. | |
44 Which one you need depends on the system you want to run it on and whether you | |
45 want or must compile it yourself. Check http://www.vim.org/download.php for | |
46 an overview of currently available distributions. | |
47 | |
8917
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
48 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
|
49 * 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
|
50 * 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
|
51 * Get a Windows executable from the |
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
52 [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
|
53 |
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
54 |
6916 | 55 |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
56 ## Compiling ## |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
57 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
58 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
|
59 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
|
60 `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
|
61 |
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 ## Installation ## |
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 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
|
66 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
|
67 archive): |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
68 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
69 README_ami.txt Amiga |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
70 README_unix.txt Unix |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
71 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
|
72 README_mac.txt Macintosh |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
73 README_vms.txt VMS |
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 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
|
76 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
77 |
6916 | 78 ## Documentation ## |
79 | |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
80 The Vim tutor is a one hour training course for beginners. Often it can be |
6916 | 81 started as `vimtutor`. See `:help tutor` for more information. |
82 | |
83 The best is to use `:help` in Vim. If you don't have an executable yet, read | |
84 `runtime/doc/help.txt`. It contains pointers to the other documentation | |
85 files. The User Manual reads like a book and is recommended to learn to use | |
86 Vim. See `:help user-manual`. | |
87 | |
88 | |
89 ## Copying ## | |
90 | |
91 Vim is Charityware. You can use and copy it as much as you like, but you are | |
92 encouraged to make a donation to help orphans in Uganda. Please read the file | |
93 `runtime/doc/uganda.txt` for details (do `:help uganda` inside Vim). | |
94 | |
95 Summary of the license: There are no restrictions on using or distributing an | |
96 unmodified copy of Vim. Parts of Vim may also be distributed, but the license | |
97 text must always be included. For modified versions a few restrictions apply. | |
98 The license is GPL compatible, you may compile Vim with GPL libraries and | |
99 distribute it. | |
100 | |
101 | |
102 ## Sponsoring ## | |
103 | |
104 Fixing bugs and adding new features takes a lot of time and effort. To show | |
105 your appreciation for the work and motivate Bram and others to continue | |
106 working on Vim please send a donation. | |
107 | |
108 Since Bram is back to a paid job the money will now be used to help children | |
109 in Uganda. See `runtime/doc/uganda.txt`. But at the same time donations | |
110 increase Bram's motivation to keep working on Vim! | |
111 | |
112 For the most recent information about sponsoring look on the Vim web site: | |
113 http://www.vim.org/sponsor/ | |
114 | |
115 | |
7127
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
116 ## Contributing ## |
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
117 |
7179
f7d6cc6b78b5
commit https://github.com/vim/vim/commit/f1a4c98ea6fa122ceb24c1ad17e184703cbfd182
Christian Brabandt <cb@256bit.org>
parents:
7177
diff
changeset
|
118 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
|
119 |
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
120 |
6916 | 121 ## Information ## |
122 | |
123 The latest news about Vim can be found on the Vim home page: | |
124 http://www.vim.org/ | |
125 | |
126 If you have problems, have a look at the Vim documentation or tips: | |
127 http://www.vim.org/docs.php | |
128 http://vim.wikia.com/wiki/Vim_Tips_Wiki | |
129 | |
130 If you still have problems or any other questions, use one of the mailing | |
131 lists to discuss them with Vim users and developers: | |
132 http://www.vim.org/maillist.php | |
133 | |
134 If nothing else works, report bugs directly: | |
135 Bram Moolenaar <Bram@vim.org> | |
136 | |
137 | |
138 ## Main author ## | |
139 | |
140 Send any other comments, patches, flowers and suggestions to: | |
141 Bram Moolenaar <Bram@vim.org> | |
14119
b5b0b87f1a39
patch 8.1.0077: header of README file is not nice
Christian Brabandt <cb@256bit.org>
parents:
14115
diff
changeset
|
142 |
b5b0b87f1a39
patch 8.1.0077: header of README file is not nice
Christian Brabandt <cb@256bit.org>
parents:
14115
diff
changeset
|
143 |
18879 | 144 This is `README.md` for version 8.2 of Vim: Vi IMproved. |
18664 | 145 |
146 | |
147 ## Translations of this README ## | |
148 | |
149 [Korean](https://github.com/cjw1359/opensource/blob/master/Vim/README_ko.md) |