Mercurial > vim
changeset 32878:aaa5c1db3731
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 | 4178fc423a69 |
| children | 49e4d7aa402c |
| files | README.md |
| diffstat | 1 files changed, 36 insertions(+), 40 deletions(-) [+] |
line wrap: on
line diff
--- a/README.md +++ b/README.md @@ -1,17 +1,21 @@ -[](https://www.vim.org) +# [](https://www.vim.org) -[](https://github.com/vim/vim/actions?query=workflow%3A%22GitHub+CI%22) [](https://ci.appveyor.com/project/chrisbra/vim) [](https://cirrus-ci.com/github/vim/vim) [](https://codecov.io/gh/vim/vim?branch=master) [](https://scan.coverity.com/projects/vim) [](https://buildd.debian.org/vim) [](https://repology.org/metapackage/vim) [](https://fossies.org/linux/test/vim-master.tar.gz/codespell.html) - -<sub>For translations of this README see the end.</sub> +[](https://github.com/vim/vim/actions?query=workflow%3A%22GitHub+CI%22) +[](https://ci.appveyor.com/project/chrisbra/vim) +[](https://cirrus-ci.com/github/vim/vim) +[](https://codecov.io/gh/vim/vim?branch=master) +[](https://scan.coverity.com/projects/vim) +[](https://buildd.debian.org/vim) +[](https://repology.org/metapackage/vim) +[](https://fossies.org/linux/test/vim-master.tar.gz/codespell.html) If you find a bug or want to discuss the best way to add a new feature, please -open an [issue](https://github.com/vim/vim/issues). +[open an issue](https://github.com/vim/vim/issues/new/choose). If you have a question or want to discuss the best way to do something with Vim, you can use [StackExchange](https://vi.stackexchange.com/) or one of the [Maillists](https://www.vim.org/community.php). - -## What is Vim? ## +## What is Vim? Vim is a greatly improved version of the good old UNIX editor [Vi](https://en.wikipedia.org/wiki/Vi). Many new @@ -35,7 +39,7 @@ Amiga DOS, Atari MiNT, BeOS, RISC OS and For Vim9 script see [README_VIM9](README_VIM9.md). -## Distribution ## +## Distribution You can often use your favorite package manager to install Vim. On Mac and Linux a small version of Vim is pre-installed, you still need to install Vim @@ -55,48 +59,45 @@ Some popular places to get the latest Vi * Get a Windows executable from the [vim-win32-installer](https://github.com/vim/vim-win32-installer/releases) repository. - - -## Compiling ## +## Compiling If you obtained a binary distribution you don't need to compile Vim. If you obtained a source distribution, all the stuff for compiling Vim is in the -[`src`](/src) directory. See [`src/INSTALL`](src/INSTALL) for instructions. +[`src`](./src/) directory. See [`src/INSTALL`](./src/INSTALL) for instructions. - -## Installation ## +## Installation See one of these files for system-specific instructions. Either in the [READMEdir directory](./READMEdir/) (in the repository) or the top directory (if you unpack an archive): - README_ami.txt Amiga - README_unix.txt Unix - README_dos.txt MS-DOS and MS-Windows - README_mac.txt Macintosh - README_haiku.txt Haiku - README_vms.txt VMS +``` +README_ami.txt Amiga +README_unix.txt Unix +README_dos.txt MS-DOS and MS-Windows +README_mac.txt Macintosh +README_haiku.txt Haiku +README_vms.txt VMS +``` There are other `README_*.txt` files, depending on the distribution you used. - -## Documentation ## +## Documentation The Vim tutor is a one hour training course for beginners. Often it can be started as `vimtutor`. See `:help tutor` for more information. The best is to use `:help` in Vim. If you don't have an executable yet, read -[`runtime/doc/help.txt`](/runtime/doc/help.txt). +[`runtime/doc/help.txt`](./runtime/doc/help.txt). It contains pointers to the other documentation files. The User Manual reads like a book and is recommended to learn to use Vim. See `:help user-manual`. - -## Copying ## +## Copying Vim is Charityware. You can use and copy it as much as you like, but you are encouraged to make a donation to help orphans in Uganda. Please read the file -[`runtime/doc/uganda.txt`](runtime/doc/uganda.txt) +[`runtime/doc/uganda.txt`](./runtime/doc/uganda.txt) for details (do `:help uganda` inside Vim). Summary of the license: There are no restrictions on using or distributing an @@ -105,28 +106,25 @@ text must always be included. For modif The license is GPL compatible, you may compile Vim with GPL libraries and distribute it. - -## Sponsoring ## +## Sponsoring Fixing bugs and adding new features takes a lot of time and effort. To show your appreciation for the work and motivate Bram and others to continue working on Vim please send a donation. Since Bram is back to a paid job the money will now be used to help children -in Uganda. See [`runtime/doc/uganda.txt`](runtime/doc/uganda.txt). But +in Uganda. See [`runtime/doc/uganda.txt`](./runtime/doc/uganda.txt). But at the same time donations increase Bram's motivation to keep working on Vim! For the most recent information about sponsoring look on the Vim web site: https://www.vim.org/sponsor/ - -## Contributing ## +## Contributing If you would like to help make Vim better, see the -[CONTRIBUTING.md](/CONTRIBUTING.md) file. +[CONTRIBUTING.md](./CONTRIBUTING.md) file. - -## Information ## +## Information If you are on macOS, you can use [Macvim](https://macvim-dev.github.io/macvim/). @@ -142,16 +140,14 @@ lists to discuss them with Vim users and https://www.vim.org/maillist.php If nothing else works, report bugs directly to the vim-dev mailing list: - <vim-dev@vim.org> - + `<vim-dev@vim.org>` -## Main author ## +## Main author -Most of Vim was created by Bram Moolenaar <Bram@vim.org> +Most of Vim was created by Bram Moolenaar `<Bram@vim.org>` [Bram-Moolenaar](https://vimhelp.org/version9.txt.html#Bram-Moolenaar) Send any other comments, patches, flowers and suggestions to the vim-dev mailing list: - <vim-dev@vim.org> - + `<vim-dev@vim.org>` This is `README.md` for version 9.0 of Vim: Vi IMproved.