Mercurial > vim

comparison README.md @ 32878:aaa5c1db3731

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: Improve Markdown in README (#12829) Commit: https://github.com/vim/vim/commit/b23db545ce7cb09ab08f1c5bfde97f44da2e8d00 Author: Viktor Sz?pe <viktor@szepe.net> Date: Sat Aug 19 14:16:10 2023 +0200 docs: Improve Markdown in README (https://github.com/vim/vim/issues/12829)
author Christian Brabandt <cb@256bit.org>
date Sat, 19 Aug 2023 14:30:04 +0200
parents 1b2730ece70e
children 4635e43f2c6f
comparison
equal deleted inserted replaced
32877:4178fc423a69 32878:aaa5c1db3731
1 [![Vim Logo](https://github.com/vim/vim/raw/master/runtime/vimlogo.gif)](https://www.vim.org) 1 # [![Vim The editor](https://github.com/vim/vim/raw/master/runtime/vimlogo.gif)](https://www.vim.org)
2 2
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) 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)
4 4 [![Appveyor Build status](https://ci.appveyor.com/api/projects/status/o2qht2kjm02sgghk?svg=true)](https://ci.appveyor.com/project/chrisbra/vim)
5 <sub>For translations of this README see the end.</sub> 5 [![Cirrus Build Status](https://api.cirrus-ci.com/github/vim/vim.svg)](https://cirrus-ci.com/github/vim/vim)
6 [![Coverage Status](https://codecov.io/gh/vim/vim/coverage.svg?branch=master)](https://codecov.io/gh/vim/vim?branch=master)
7 [![Coverity Scan](https://scan.coverity.com/projects/241/badge.svg)](https://scan.coverity.com/projects/vim)
8 [![Debian CI](https://badges.debian.net/badges/debian/testing/vim/version.svg)](https://buildd.debian.org/vim)
9 [![Packages](https://repology.org/badge/tiny-repos/vim.svg)](https://repology.org/metapackage/vim)
10 [![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)
6 11
7 If you find a bug or want to discuss the best way to add a new feature, please 12 If you find a bug or want to discuss the best way to add a new feature, please
8 open an [issue](https://github.com/vim/vim/issues). 13 [open an issue](https://github.com/vim/vim/issues/new/choose).
9 If you have a question or want to discuss the best way to do something with 14 If you have a question or want to discuss the best way to do something with
10 Vim, you can use [StackExchange](https://vi.stackexchange.com/) 15 Vim, you can use [StackExchange](https://vi.stackexchange.com/)
11 or one of the [Maillists](https://www.vim.org/community.php). 16 or one of the [Maillists](https://www.vim.org/community.php).
12 17
13 18 ## What is Vim?
14 ## What is Vim? ##
15 19
16 Vim is a greatly improved version of the good old UNIX editor 20 Vim is a greatly improved version of the good old UNIX editor
17 [Vi](https://en.wikipedia.org/wiki/Vi). Many new 21 [Vi](https://en.wikipedia.org/wiki/Vi). Many new
18 features have been added: multi-level undo, syntax highlighting, command line 22 features have been added: multi-level undo, syntax highlighting, command line
19 history, on-line help, spell checking, filename completion, block operations, 23 history, on-line help, spell checking, filename completion, block operations,
33 Older versions of Vim run on MS-DOS, MS-Windows 95/98/Me/NT/2000/XP/Vista, 37 Older versions of Vim run on MS-DOS, MS-Windows 95/98/Me/NT/2000/XP/Vista,
34 Amiga DOS, Atari MiNT, BeOS, RISC OS and OS/2. These are no longer maintained. 38 Amiga DOS, Atari MiNT, BeOS, RISC OS and OS/2. These are no longer maintained.
35 39
36 For Vim9 script see [README_VIM9](README_VIM9.md). 40 For Vim9 script see [README_VIM9](README_VIM9.md).
37 41
38 ## Distribution ## 42 ## Distribution
39 43
40 You can often use your favorite package manager to install Vim. On Mac and 44 You can often use your favorite package manager to install Vim. On Mac and
41 Linux a small version of Vim is pre-installed, you still need to install Vim 45 Linux a small version of Vim is pre-installed, you still need to install Vim
42 if you want more features. 46 if you want more features.
43 47
53 * Check out the git repository from [GitHub](https://github.com/vim/vim). 57 * Check out the git repository from [GitHub](https://github.com/vim/vim).
54 * Get the source code as an [archive](https://github.com/vim/vim/releases). 58 * Get the source code as an [archive](https://github.com/vim/vim/releases).
55 * Get a Windows executable from the 59 * Get a Windows executable from the
56 [vim-win32-installer](https://github.com/vim/vim-win32-installer/releases) repository. 60 [vim-win32-installer](https://github.com/vim/vim-win32-installer/releases) repository.
57 61
58 62 ## Compiling
59
60 ## Compiling ##
61 63
62 If you obtained a binary distribution you don't need to compile Vim. If you 64 If you obtained a binary distribution you don't need to compile Vim. If you
63 obtained a source distribution, all the stuff for compiling Vim is in the 65 obtained a source distribution, all the stuff for compiling Vim is in the
64 [`src`](/src) directory. See [`src/INSTALL`](src/INSTALL) for instructions. 66 [`src`](./src/) directory. See [`src/INSTALL`](./src/INSTALL) for instructions.
65 67
66 68 ## Installation
67 ## Installation ##
68 69
69 See one of these files for system-specific instructions. Either in the 70 See one of these files for system-specific instructions. Either in the
70 [READMEdir directory](./READMEdir/) (in the repository) or 71 [READMEdir directory](./READMEdir/) (in the repository) or
71 the top directory (if you unpack an archive): 72 the top directory (if you unpack an archive):
72 73
73 README_ami.txt Amiga 74 ```
74 README_unix.txt Unix 75 README_ami.txt Amiga
75 README_dos.txt MS-DOS and MS-Windows 76 README_unix.txt Unix
76 README_mac.txt Macintosh 77 README_dos.txt MS-DOS and MS-Windows
77 README_haiku.txt Haiku 78 README_mac.txt Macintosh
78 README_vms.txt VMS 79 README_haiku.txt Haiku
80 README_vms.txt VMS
81 ```
79 82
80 There are other `README_*.txt` files, depending on the distribution you used. 83 There are other `README_*.txt` files, depending on the distribution you used.
81 84
82 85 ## Documentation
83 ## Documentation ##
84 86
85 The Vim tutor is a one hour training course for beginners. Often it can be 87 The Vim tutor is a one hour training course for beginners. Often it can be
86 started as `vimtutor`. See `:help tutor` for more information. 88 started as `vimtutor`. See `:help tutor` for more information.
87 89
88 The best is to use `:help` in Vim. If you don't have an executable yet, read 90 The best is to use `:help` in Vim. If you don't have an executable yet, read
89 [`runtime/doc/help.txt`](/runtime/doc/help.txt). 91 [`runtime/doc/help.txt`](./runtime/doc/help.txt).
90 It contains pointers to the other documentation files. 92 It contains pointers to the other documentation files.
91 The User Manual reads like a book and is recommended to learn to use 93 The User Manual reads like a book and is recommended to learn to use
92 Vim. See `:help user-manual`. 94 Vim. See `:help user-manual`.
93 95
94 96 ## Copying
95 ## Copying ##
96 97
97 Vim is Charityware. You can use and copy it as much as you like, but you are 98 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 99 encouraged to make a donation to help orphans in Uganda. Please read the file
99 [`runtime/doc/uganda.txt`](runtime/doc/uganda.txt) 100 [`runtime/doc/uganda.txt`](./runtime/doc/uganda.txt)
100 for details (do `:help uganda` inside Vim). 101 for details (do `:help uganda` inside Vim).
101 102
102 Summary of the license: There are no restrictions on using or distributing an 103 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 104 unmodified copy of Vim. Parts of Vim may also be distributed, but the license
104 text must always be included. For modified versions, a few restrictions apply. 105 text must always be included. For modified versions, a few restrictions apply.
105 The license is GPL compatible, you may compile Vim with GPL libraries and 106 The license is GPL compatible, you may compile Vim with GPL libraries and
106 distribute it. 107 distribute it.
107 108
108 109 ## Sponsoring
109 ## Sponsoring ##
110 110
111 Fixing bugs and adding new features takes a lot of time and effort. To show 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 112 your appreciation for the work and motivate Bram and others to continue
113 working on Vim please send a donation. 113 working on Vim please send a donation.
114 114
115 Since Bram is back to a paid job the money will now be used to help children 115 Since Bram is back to a paid job the money will now be used to help children
116 in Uganda. See [`runtime/doc/uganda.txt`](runtime/doc/uganda.txt). But 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! 117 at the same time donations increase Bram's motivation to keep working on Vim!
118 118
119 For the most recent information about sponsoring look on the Vim web site: 119 For the most recent information about sponsoring look on the Vim web site:
120 https://www.vim.org/sponsor/ 120 https://www.vim.org/sponsor/
121 121
122 122 ## Contributing
123 ## Contributing ##
124 123
125 If you would like to help make Vim better, see the 124 If you would like to help make Vim better, see the
126 [CONTRIBUTING.md](/CONTRIBUTING.md) file. 125 [CONTRIBUTING.md](./CONTRIBUTING.md) file.
127 126
128 127 ## Information
129 ## Information ##
130 128
131 If you are on macOS, you can use [Macvim](https://macvim-dev.github.io/macvim/). 129 If you are on macOS, you can use [Macvim](https://macvim-dev.github.io/macvim/).
132 130
133 The latest news about Vim can be found on the Vim home page: 131 The latest news about Vim can be found on the Vim home page:
134 https://www.vim.org/ 132 https://www.vim.org/
140 If you still have problems or any other questions, use one of the mailing 138 If you still have problems or any other questions, use one of the mailing
141 lists to discuss them with Vim users and developers: 139 lists to discuss them with Vim users and developers:
142 https://www.vim.org/maillist.php 140 https://www.vim.org/maillist.php
143 141
144 If nothing else works, report bugs directly to the vim-dev mailing list: 142 If nothing else works, report bugs directly to the vim-dev mailing list:
145 <vim-dev@vim.org> 143 `<vim-dev@vim.org>`
146 144
145 ## Main author
147 146
148 ## Main author ## 147 Most of Vim was created by Bram Moolenaar `<Bram@vim.org>`
149
150 Most of Vim was created by Bram Moolenaar <Bram@vim.org>
151 [Bram-Moolenaar](https://vimhelp.org/version9.txt.html#Bram-Moolenaar) 148 [Bram-Moolenaar](https://vimhelp.org/version9.txt.html#Bram-Moolenaar)
152 149
153 Send any other comments, patches, flowers and suggestions to the vim-dev mailing list: 150 Send any other comments, patches, flowers and suggestions to the vim-dev mailing list:
154 <vim-dev@vim.org> 151 `<vim-dev@vim.org>`
155
156 152
157 This is `README.md` for version 9.0 of Vim: Vi IMproved. 153 This is `README.md` for version 9.0 of Vim: Vi IMproved.