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