summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorBram Moolenaar <Bram@vim.org>2021-04-17 16:31:09 +0200
committerBram Moolenaar <Bram@vim.org>2021-04-17 16:31:09 +0200
commit56994d215815139207f3c5ce02a1720e44e93c09 (patch)
tree4a168880e92d7627c168fe7bfc6febc369af15a2 /README.md
parent112a006417a0d4700ff39ddba3bb5e985ae9770f (diff)
Update runtime files.
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 17 insertions, 12 deletions
diff --git a/README.md b/README.md
index c7491ebd0d..0a985d4125 100644
--- a/README.md
+++ b/README.md
@@ -7,12 +7,14 @@
## What is Vim? ##
-Vim is a greatly improved version of the good old UNIX editor Vi. Many new
+Vim is a greatly improved version of the good old UNIX editor
+[Vi](https://en.wikipedia.org/wiki/Vi). Many new
features have been added: multi-level undo, syntax highlighting, command line
history, on-line help, spell checking, filename completion, block operations,
script language, etc. There is also a Graphical User Interface (GUI)
available. Still, Vi compatibility is maintained, those who have Vi "in the
-fingers" will feel at home. See `runtime/doc/vi_diff.txt` for differences with
+fingers" will feel at home.
+See [`runtime/doc/vi_diff.txt`](runtime/doc/vi_diff.txt) for differences with
Vi.
This editor is very useful for editing programs and other plain text files.
@@ -42,7 +44,7 @@ want or must compile it yourself. Check http://www.vim.org/download.php for
an overview of currently available distributions.
Some popular places to get the latest Vim:
-* Check out the git repository from [github](https://github.com/vim/vim).
+* Check out the git repository from [GitHub](https://github.com/vim/vim).
* Get the source code as an [archive](https://github.com/vim/vim/releases).
* Get a Windows executable from the
[vim-win32-installer](https://github.com/vim/vim-win32-installer/releases) repository.
@@ -53,14 +55,14 @@ Some popular places to get the latest Vim:
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` directory. See `src/INSTALL` for instructions.
+[`src`](/src) directory. See [`src/INSTALL`](src/INSTALL) for instructions.
## Installation ##
See one of these files for system-specific instructions. Either in the
-READMEdir directory (in the repository) or the top directory (if you unpack an
-archive):
+[READMEdir directory](./READMEdir/) (in the repository) or
+the top directory (if you unpack an archive):
README_ami.txt Amiga
README_unix.txt Unix
@@ -78,8 +80,9 @@ 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`. It contains pointers to the other documentation
-files. The User Manual reads like a book and is recommended to learn to use
+[`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`.
@@ -87,7 +90,8 @@ Vim. See `:help user-manual`.
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` for details (do `:help uganda` inside Vim).
+[`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
unmodified copy of Vim. Parts of Vim may also be distributed, but the license
@@ -103,8 +107,8 @@ 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`. But at the same time donations
-increase Bram's motivation to keep working on Vim!
+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:
http://www.vim.org/sponsor/
@@ -112,7 +116,8 @@ For the most recent information about sponsoring look on the Vim web site:
## Contributing ##
-If you would like to help making Vim better, see the [CONTRIBUTING.md](https://github.com/vim/vim/blob/master/CONTRIBUTING.md) file.
+If you would like to help making Vim better, see the
+[CONTRIBUTING.md](/CONTRIBUTING.md) file.
## Information ##