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