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