README.md

   1 # [![Vim The editor](https://github.com/vim/vim/raw/master/runtime/vimlogo.gif)](https://www.vim.org)
   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)
   4 [![Appveyor Build status](https://ci.appveyor.com/api/projects/status/o2qht2kjm02sgghk?svg=true)](https://ci.appveyor.com/project/chrisbra/vim)
   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)
  11
  12 If you find a bug or want to discuss the best way to add a new feature, please
  13 [open an issue](https://github.com/vim/vim/issues/new/choose).
  14 If you have a question or want to discuss the best way to do something with
  15 Vim, you can use [StackExchange](https://vi.stackexchange.com/)
  16 or one of the [Maillists](https://www.vim.org/community.php).
  17
  18 ## What is Vim?
  19
  20 Vim is a greatly improved version of the good old UNIX editor
  21 [Vi](https://en.wikipedia.org/wiki/Vi).  Many new
  22 features have been added: multi-level undo, syntax highlighting, command line
  23 history, on-line help, spell checking, filename completion, block operations,
  24 script language, etc.  There is also a Graphical User Interface (GUI)
  25 available.  Still, Vi compatibility is maintained, those who have Vi "in the
  26 fingers" will feel at home.
  27 See [`runtime/doc/vi_diff.txt`](runtime/doc/vi_diff.txt) for differences with
  28 Vi.
  29
  30 This editor is very useful for editing programs and other plain text files.
  31 All commands are given with normal keyboard characters, so those who can type
  32 with ten fingers can work very fast.  Additionally, function keys can be
  33 mapped to commands by the user, and the mouse can be used.
  34
  35 Vim runs under MS-Windows (7, 8, 10, 11), macOS, Haiku, VMS and almost all
  36 flavours of UNIX.  Porting to other systems should not be very difficult.
  37 Older versions of Vim run on MS-DOS, MS-Windows 95/98/Me/NT/2000/XP/Vista,
  38 Amiga DOS, Atari MiNT, BeOS, RISC OS and OS/2.  These are no longer maintained.
  39
  40 For Vim9 script see [README_VIM9](README_VIM9.md).
  41
  42 ## Distribution
  43
  44 You can often use your favorite package manager to install Vim.  On Mac and
  45 Linux a small version of Vim is pre-installed, you still need to install Vim
  46 if you want more features.
  47
  48 There are separate distributions for Unix, PC, Amiga and some other systems.
  49 This `README.md` file comes with the runtime archive.  It includes the
  50 documentation, syntax files and other files that are used at runtime.  To run
  51 Vim you must get either one of the binary archives or a source archive.
  52 Which one you need depends on the system you want to run it on and whether you
  53 want or must compile it yourself.  Check https://www.vim.org/download.php for
  54 an overview of currently available distributions.
  55
  56 Some popular places to get the latest Vim:
  57 * Check out the git repository from [GitHub](https://github.com/vim/vim).
  58 * Get the source code as an [archive](https://github.com/vim/vim/releases).
  59 * Get a Windows executable from the
  60 [vim-win32-installer](https://github.com/vim/vim-win32-installer/releases) repository.
  61
  62 ## Compiling
  63
  64 If you obtained a binary distribution you don't need to compile Vim.  If you
  65 obtained a source distribution, all the stuff for compiling Vim is in the
  66 [`src`](./src/) directory.  See [`src/INSTALL`](./src/INSTALL) for instructions.
  67
  68 ## Installation
  69
  70 See one of these files for system-specific instructions.  Either in the
  71 [READMEdir directory](./READMEdir/) (in the repository) or
  72 the top directory (if you unpack an archive):
  73
  74 ```
  75 README_ami.txt          Amiga
  76 README_unix.txt         Unix
  77 README_dos.txt          MS-DOS and MS-Windows
  78 README_mac.txt          Macintosh
  79 README_haiku.txt        Haiku
  80 README_vms.txt          VMS
  81 ```
  82
  83 There are other `README_*.txt` files, depending on the distribution you used.
  84
  85 ## Documentation
  86
  87 The Vim tutor is a one hour training course for beginners.  Often it can be
  88 started as `vimtutor`.  See `:help tutor` for more information.
  89
  90 The best is to use `:help` in Vim.  If you don't have an executable yet, read
  91 [`runtime/doc/help.txt`](./runtime/doc/help.txt).
  92 It contains pointers to the other documentation files.
  93 The User Manual reads like a book and is recommended to learn to use
  94 Vim.  See `:help user-manual`.
  95
  96 ## Copying
  97
  98 Vim is Charityware.  You can use and copy it as much as you like, but you are
  99 encouraged to make a donation to help orphans in Uganda.  Please read the file
 100 [`runtime/doc/uganda.txt`](./runtime/doc/uganda.txt)
 101 for details (do `:help uganda` inside Vim).
 102
 103 Summary of the license: There are no restrictions on using or distributing an
 104 unmodified copy of Vim.  Parts of Vim may also be distributed, but the license
 105 text must always be included.  For modified versions, a few restrictions apply.
 106 The license is GPL compatible, you may compile Vim with GPL libraries and
 107 distribute it.
 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 developers to continue working on
 113 Vim please send a donation.
 114
 115 The money you donated will be mainly used to help children in Uganda.  See
 116 [`runtime/doc/uganda.txt`](./runtime/doc/uganda.txt).  But at the same time
 117 donations increase the development team motivation to keep working on Vim!
 118
 119 For the most recent information about sponsoring look on the Vim web site:
 120         https://www.vim.org/sponsor/
 121
 122 ## Contributing
 123
 124 If you would like to help make Vim better, see the
 125 [CONTRIBUTING.md](./CONTRIBUTING.md) file.
 126
 127 ## Information
 128
 129 If you are on macOS, you can use [MacVim](https://macvim.org).
 130
 131 The latest news about Vim can be found on the Vim home page:
 132         https://www.vim.org/
 133
 134 If you have problems, have a look at the Vim documentation or tips:
 135         https://www.vim.org/docs.php
 136         https://vim.fandom.com/wiki/Vim_Tips_Wiki
 137
 138 If you still have problems or any other questions, use one of the mailing
 139 lists to discuss them with Vim users and developers:
 140         https://www.vim.org/maillist.php
 141
 142 If nothing else works, report bugs directly to the vim-dev mailing list:
 143         `<vim-dev@vim.org>`
 144
 145 ## Main author
 146
 147 Most of Vim was created by Bram Moolenaar `<Bram@vim.org>`
 148 [Bram-Moolenaar](https://vimhelp.org/version9.txt.html#Bram-Moolenaar)
 149
 150 Send any other comments, patches, flowers and suggestions to the vim-dev mailing list:
 151         `<vim-dev@vim.org>`
 152
 153 This is `README.md` for version 9.1 of Vim: Vi IMproved.