codekingpro/portable-devtools

1README.txt for version 9.2 of Vim: Vi IMproved.2 3 4WHAT IS VIM?5 6Vim is a greatly improved version of the good old UNIX editor Vi.  Many new7features have been added: multi-level undo, syntax highlighting, command line8history, on-line help, spell checking, filename completion, block operations,9script language, etc.  There is also a Graphical User Interface (GUI) available.10Still, Vi compatibility is maintained, those who have Vi "in the fingers" will11feel at home.  See "runtime/doc/vi_diff.txt" for differences with Vi.12 13This editor is very useful for editing programs and other plain text files.14All commands are given with normal keyboard characters, so those who can type15with ten fingers can work very fast.  Additionally, function keys can be16mapped to commands by the user, and the mouse can be used.17 18Vim also aims to provide a (mostly) POSIX-compatible vi implementation, when19compiled with a minimal feature set (typically called vim.tiny), which is used20by many Linux distributions as the default vi editor.21 22Vim runs under MS-Windows (7, 8, 10, 11), macOS, Haiku, VMS and almost all23flavours of UNIX.  Porting to other systems should not be very difficult.24Older versions of Vim run on MS-DOS, MS-Windows 95/98/Me/NT/2000/XP/Vista,25Amiga DOS, Atari MiNT, BeOS, RISC OS and OS/2.  These are no longer maintained.26 27 28DISTRIBUTION29 30You can often use your favorite package manager to install Vim.  On Mac and31Linux a small version of Vim is pre-installed, you still need to install Vim32if you want more features.33 34There are separate distributions for Unix, PC, Amiga and some other systems.35This README.txt file comes with the runtime archive.  It includes the36documentation, syntax files and other files that are used at runtime.  To run37Vim you must get either one of the binary archives or a source archive.38Which one you need depends on the system you want to run it on and whether you39want or must compile it yourself.  Check "https://www.vim.org/download.php" for40an overview of currently available distributions.41 42Some 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 49COMPILING50 51If you obtained a binary distribution you don't need to compile Vim.  If you52obtained a source distribution, all the stuff for compiling Vim is in the53"src" directory.  See src/INSTALL for instructions.54 55 56INSTALLATION57 58See one of these files for system-specific instructions.  Either in the59READMEdir directory (in the repository) or the top directory (if you unpack an60archive):61 62README_ami.txt		Amiga63README_unix.txt		Unix64README_dos.txt		MS-DOS and MS-Windows65README_mac.txt		Macintosh66README_haiku.txt	Haiku67README_vms.txt		VMS68 69There are other README_*.txt files, depending on the distribution you used.70 71 72DOCUMENTATION73 74The Vim tutor is a one hour training course for beginners.  Often it can be75started as "vimtutor".  See ":help tutor" for more information.76 77The best is to use ":help" in Vim.  If you don't have an executable yet, read78"runtime/doc/help.txt".  It contains pointers to the other documentation files.79The User Manual reads like a book and is recommended to learn to use Vim.  See80":help user-manual".81 82 83COPYING84 85Vim is Charityware.  You can use and copy it as much as you like, but you are86encouraged to make a donation to help orphans in Uganda.  Please read the file87"runtime/doc/uganda.txt" for details (do ":help uganda" inside Vim).88 89Summary of the license: There are no restrictions on using or distributing an90unmodified copy of Vim.  Parts of Vim may also be distributed, but the license91text must always be included.  For modified versions, a few restrictions apply.92The license is GPL compatible, you may compile Vim with GPL libraries and93distribute it.94 95 96SPONSORING97 98Fixing bugs and adding new features takes a lot of time and effort.  To show99your appreciation for the work and motivate developers to continue working on100Vim please send a donation.101 102The money you donated will be mainly used to help children in Uganda.  See103"runtime/doc/uganda.txt".  But at the same time donations increase the104development team motivation to keep working on Vim!105 106For the most recent information about sponsoring look on the Vim web site:107	https://www.vim.org/sponsor/108 109 110CONTRIBUTING111 112If you would like to help make Vim better, see the CONTRIBUTING.md file.113 114 115INFORMATION116 117If you are on macOS, you can use MacVim: https://macvim.org118 119The latest news about Vim can be found on the Vim home page:120	https://www.vim.org/121 122If you have problems, have a look at the Vim documentation or tips:123	https://www.vim.org/docs.php124	https://vim.fandom.com/wiki/Vim_Tips_Wiki125 126If you still have problems or any other questions, use one of the mailing lists127to discuss them with Vim users and developers:128	https://www.vim.org/maillist.php129 130If nothing else works, report bugs directly to the vim-dev mailing list:131	<vim-dev@vim.org>132 133 134MAIN AUTHOR135 136Most of Vim was created by Bram Moolenaar <Bram@vim.org>, ":help Bram-Moolenaar"137 138Send any other comments, patches, flowers and suggestions to the vim-dev139mailing list: <vim-dev@vim.org>140