Mercurial > vim
annotate README.md @ 32517:7e989714b555 v9.0.1590
patch 9.0.1590: filetype test has trailing white space
Commit: https://github.com/vim/vim/commit/247caa378fc1121c99ecc594fab024691a6d7a9b
Author: Bram Moolenaar <Bram@vim.org>
Date: Mon May 29 17:37:13 2023 +0100
patch 9.0.1590: filetype test has trailing white space
Problem: Filetype test has trailing white space.
Solution: Remove trailing white space.
author | Bram Moolenaar <Bram@vim.org> |
---|---|
date | Mon, 29 May 2023 18:45:07 +0200 |
parents | 5c3badaed23d |
children | 4027cefc2aab |
rev | line source |
---|---|
23324
863683061a02
Attempt to align the logo without a markdown table.
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
1 [![Vim Logo](https://github.com/vim/vim/raw/master/runtime/vimlogo.gif)](https://www.vim.org) |
23327 | 2 |
31676
5c3badaed23d
patch 9.0.1170: LGTM badge no longer works
Bram Moolenaar <Bram@vim.org>
parents:
31579
diff
changeset
|
3 [![Github Build status](https://github.com/vim/vim/workflows/GitHub%20CI/badge.svg)](https://github.com/vim/vim/actions?query=workflow%3A%22GitHub+CI%22) [![Appveyor Build status](https://ci.appveyor.com/api/projects/status/o2qht2kjm02sgghk?svg=true)](https://ci.appveyor.com/project/chrisbra/vim) [![Cirrus Build Status](https://api.cirrus-ci.com/github/vim/vim.svg)](https://cirrus-ci.com/github/vim/vim) [![Coverage Status](https://codecov.io/gh/vim/vim/coverage.svg?branch=master)](https://codecov.io/gh/vim/vim?branch=master) [![Coverity Scan](https://scan.coverity.com/projects/241/badge.svg)](https://scan.coverity.com/projects/vim) [![Debian CI](https://badges.debian.net/badges/debian/testing/vim/version.svg)](https://buildd.debian.org/vim) [![Packages](https://repology.org/badge/tiny-repos/vim.svg)](https://repology.org/metapackage/vim) [![Fossies codespell report](https://fossies.org/linux/test/vim-master.tar.gz/codespell.svg)](https://fossies.org/linux/test/vim-master.tar.gz/codespell.html) |
23324
863683061a02
Attempt to align the logo without a markdown table.
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
4 |
23327 | 5 <sub>For translations of this README see the end.</sub> |
6916 | 6 |
24892
e73a9667e471
Add links to discussion forums.
Bram Moolenaar <Bram@vim.org>
parents:
24468
diff
changeset
|
7 If you find a bug or want to discuss the best way to add a new feature, please |
e73a9667e471
Add links to discussion forums.
Bram Moolenaar <Bram@vim.org>
parents:
24468
diff
changeset
|
8 open an [issue](https://github.com/vim/vim/issues). |
e73a9667e471
Add links to discussion forums.
Bram Moolenaar <Bram@vim.org>
parents:
24468
diff
changeset
|
9 If you have a question or want to discuss the best way to do something with |
e73a9667e471
Add links to discussion forums.
Bram Moolenaar <Bram@vim.org>
parents:
24468
diff
changeset
|
10 Vim, you can use [StackExchange](https://vi.stackexchange.com/) |
e73a9667e471
Add links to discussion forums.
Bram Moolenaar <Bram@vim.org>
parents:
24468
diff
changeset
|
11 or one of the [Maillists](https://www.vim.org/community.php). |
e73a9667e471
Add links to discussion forums.
Bram Moolenaar <Bram@vim.org>
parents:
24468
diff
changeset
|
12 |
6916 | 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 |
24468 | 16 Vim is a greatly improved version of the good old UNIX editor |
17 [Vi](https://en.wikipedia.org/wiki/Vi). Many new | |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
18 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
|
19 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
|
20 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
|
21 available. Still, Vi compatibility is maintained, those who have Vi "in the |
24468 | 22 fingers" will feel at home. |
23 See [`runtime/doc/vi_diff.txt`](runtime/doc/vi_diff.txt) for differences with | |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
24 Vi. |
6916 | 25 |
26 This editor is very useful for editing programs and other plain text files. | |
27 All commands are given with normal keyboard characters, so those who can type | |
28 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
|
29 mapped to commands by the user, and the mouse can be used. |
6916 | 30 |
30320
0763cb330a65
patch 9.0.0496: no good reason to keep supporting Windows-XP
Bram Moolenaar <Bram@vim.org>
parents:
29533
diff
changeset
|
31 Vim runs under MS-Windows (7, 8, 10, 11), macOS, Haiku, VMS and almost all |
0763cb330a65
patch 9.0.0496: no good reason to keep supporting Windows-XP
Bram Moolenaar <Bram@vim.org>
parents:
29533
diff
changeset
|
32 flavours of UNIX. Porting to other systems should not be very difficult. |
0763cb330a65
patch 9.0.0496: no good reason to keep supporting Windows-XP
Bram Moolenaar <Bram@vim.org>
parents:
29533
diff
changeset
|
33 Older versions of Vim run on MS-DOS, MS-Windows 95/98/Me/NT/2000/XP/Vista, |
0763cb330a65
patch 9.0.0496: no good reason to keep supporting Windows-XP
Bram Moolenaar <Bram@vim.org>
parents:
29533
diff
changeset
|
34 Amiga DOS, Atari MiNT, BeOS, RISC OS and OS/2. These are no longer maintained. |
6916 | 35 |
19181
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19125
diff
changeset
|
36 For Vim9 script see [README_VIM9](README_VIM9.md). |
94eda51ba9ba
patch 8.2.0149: maintaining a Vim9 branch separately is more work
Bram Moolenaar <Bram@vim.org>
parents:
19125
diff
changeset
|
37 |
6916 | 38 ## Distribution ## |
39 | |
7177
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
7137
diff
changeset
|
40 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
|
41 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
|
42 if you want more features. |
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
7137
diff
changeset
|
43 |
6916 | 44 There are separate distributions for Unix, PC, Amiga and some other systems. |
45 This `README.md` file comes with the runtime archive. It includes the | |
46 documentation, syntax files and other files that are used at runtime. To run | |
47 Vim you must get either one of the binary archives or a source archive. | |
48 Which one you need depends on the system you want to run it on and whether you | |
25700 | 49 want or must compile it yourself. Check https://www.vim.org/download.php for |
6916 | 50 an overview of currently available distributions. |
51 | |
8917
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
52 Some popular places to get the latest Vim: |
24468 | 53 * Check out the git repository from [GitHub](https://github.com/vim/vim). |
8917
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
54 * 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
|
55 * Get a Windows executable from the |
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
56 [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
|
57 |
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
58 |
6916 | 59 |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
60 ## Compiling ## |
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 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
|
63 obtained a source distribution, all the stuff for compiling Vim is in the |
24468 | 64 [`src`](/src) directory. See [`src/INSTALL`](src/INSTALL) for instructions. |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
65 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
66 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
67 ## Installation ## |
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 See one of these files for system-specific instructions. Either in the |
24468 | 70 [READMEdir directory](./READMEdir/) (in the repository) or |
71 the top directory (if you unpack an archive): | |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
72 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
73 README_ami.txt Amiga |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
74 README_unix.txt Unix |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
75 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
|
76 README_mac.txt Macintosh |
20134
352701a626ed
patch 8.2.0622: Haiku: GUI does not compile
Bram Moolenaar <Bram@vim.org>
parents:
19181
diff
changeset
|
77 README_haiku.txt Haiku |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
78 README_vms.txt VMS |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
79 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
80 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
|
81 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
82 |
6916 | 83 ## Documentation ## |
84 | |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
8619
diff
changeset
|
85 The Vim tutor is a one hour training course for beginners. Often it can be |
6916 | 86 started as `vimtutor`. See `:help tutor` for more information. |
87 | |
88 The best is to use `:help` in Vim. If you don't have an executable yet, read | |
25700 | 89 [`runtime/doc/help.txt`](/runtime/doc/help.txt). |
24468 | 90 It contains pointers to the other documentation files. |
91 The User Manual reads like a book and is recommended to learn to use | |
6916 | 92 Vim. See `:help user-manual`. |
93 | |
94 | |
95 ## Copying ## | |
96 | |
97 Vim is Charityware. You can use and copy it as much as you like, but you are | |
98 encouraged to make a donation to help orphans in Uganda. Please read the file | |
24468 | 99 [`runtime/doc/uganda.txt`](runtime/doc/uganda.txt) |
100 for details (do `:help uganda` inside Vim). | |
6916 | 101 |
102 Summary of the license: There are no restrictions on using or distributing an | |
103 unmodified copy of Vim. Parts of Vim may also be distributed, but the license | |
31579 | 104 text must always be included. For modified versions, a few restrictions apply. |
6916 | 105 The license is GPL compatible, you may compile Vim with GPL libraries and |
106 distribute it. | |
107 | |
108 | |
109 ## Sponsoring ## | |
110 | |
111 Fixing bugs and adding new features takes a lot of time and effort. To show | |
112 your appreciation for the work and motivate Bram and others to continue | |
113 working on Vim please send a donation. | |
114 | |
115 Since Bram is back to a paid job the money will now be used to help children | |
24468 | 116 in Uganda. See [`runtime/doc/uganda.txt`](runtime/doc/uganda.txt). But |
117 at the same time donations increase Bram's motivation to keep working on Vim! | |
6916 | 118 |
119 For the most recent information about sponsoring look on the Vim web site: | |
25700 | 120 https://www.vim.org/sponsor/ |
6916 | 121 |
122 | |
7127
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
123 ## Contributing ## |
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
124 |
31579 | 125 If you would like to help make Vim better, see the |
24468 | 126 [CONTRIBUTING.md](/CONTRIBUTING.md) file. |
7127
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
127 |
e945a8e35535
commit https://github.com/vim/vim/commit/3fe076f0feb91460266fdf7f9133a59c49a53c4e
Christian Brabandt <cb@256bit.org>
parents:
6916
diff
changeset
|
128 |
6916 | 129 ## Information ## |
130 | |
29533 | 131 If you are on macOS, you can use [Macvim](https://macvim-dev.github.io/macvim/). |
132 | |
6916 | 133 The latest news about Vim can be found on the Vim home page: |
25700 | 134 https://www.vim.org/ |
6916 | 135 |
136 If you have problems, have a look at the Vim documentation or tips: | |
25700 | 137 https://www.vim.org/docs.php |
138 https://vim.fandom.com/wiki/Vim_Tips_Wiki | |
6916 | 139 |
140 If you still have problems or any other questions, use one of the mailing | |
141 lists to discuss them with Vim users and developers: | |
25700 | 142 https://www.vim.org/maillist.php |
6916 | 143 |
144 If nothing else works, report bugs directly: | |
145 Bram Moolenaar <Bram@vim.org> | |
146 | |
147 | |
148 ## Main author ## | |
149 | |
150 Send any other comments, patches, flowers and suggestions to: | |
151 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
|
152 |
b5b0b87f1a39
patch 8.1.0077: header of README file is not nice
Christian Brabandt <cb@256bit.org>
parents:
14115
diff
changeset
|
153 |
29314 | 154 This is `README.md` for version 9.0 of Vim: Vi IMproved. |