vim

Fork of vim, an acceptable text editor
git clone git://git.laack.co/vim.git
Log | Files | Refs | README | LICENSE

README.md (6968B)


      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 [![Coverage Status](https://codecov.io/gh/vim/vim/coverage.svg?branch=master)](https://codecov.io/gh/vim/vim?branch=master)
      5 [![Coverity Scan](https://scan.coverity.com/projects/241/badge.svg)](https://scan.coverity.com/projects/vim)
      6 [![Debian CI](https://badges.debian.net/badges/debian/testing/vim/version.svg)](https://buildd.debian.org/vim)
      7 [![Packages](https://repology.org/badge/tiny-repos/vim.svg)](https://repology.org/metapackage/vim)
      8 [![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)
      9 
     10 If you find a bug or want to discuss the best way to add a new feature, please
     11 [open an issue](https://github.com/vim/vim/issues/new/choose).
     12 If you have a question or want to discuss the best way to do something with
     13 Vim, you can join [`#vim`](https://web.libera.chat/#vim),
     14 [reddit.com/r/vim](https://reddit.com/r/vim),
     15 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_%28text_editor%29).  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 also aims to provide a (mostly) POSIX-compatible vi implementation, when
     36 compiled with a minimal feature set (typically called vim.tiny), which is used
     37 by many Linux distributions as the default vi editor.
     38 
     39 Vim runs under MS-Windows (7, 8, 10, 11), macOS, Haiku, VMS and almost all
     40 flavours of UNIX.  Porting to other systems should not be very difficult.
     41 Older versions of Vim run on MS-DOS, MS-Windows 95/98/Me/NT/2000/XP/Vista,
     42 Amiga DOS, Atari MiNT, BeOS, RISC OS and OS/2.  These are no longer maintained.
     43 
     44 For Vim9 script see [README_VIM9](README_VIM9.md).
     45 
     46 ## Distribution
     47 
     48 You can often use your favorite package manager to install Vim.  On Mac and
     49 Linux a small version of Vim is pre-installed, you still need to install Vim
     50 if you want more features.
     51 
     52 There are separate distributions for Unix, PC, Amiga and some other systems.
     53 This `README.md` file comes with the runtime archive.  It includes the
     54 documentation, syntax files and other files that are used at runtime.  To run
     55 Vim you must get either one of the binary archives or a source archive.
     56 Which one you need depends on the system you want to run it on and whether you
     57 want or must compile it yourself.  Check https://www.vim.org/download.php for
     58 an overview of currently available distributions.
     59 
     60 Some popular places to get the latest Vim:
     61 * Check out the git repository from [GitHub](https://github.com/vim/vim).
     62 * Get the source code as an [archive](https://github.com/vim/vim/tags).
     63 * Get a Windows executable from the
     64 [vim-win32-installer](https://github.com/vim/vim-win32-installer/releases) repository.
     65 
     66 ## Compiling
     67 
     68 If you obtained a binary distribution you don't need to compile Vim.  If you
     69 obtained a source distribution, all the stuff for compiling Vim is in the
     70 [`src`](./src/) directory.  See [`src/INSTALL`](./src/INSTALL) for instructions.
     71 
     72 ## Installation
     73 
     74 See one of these files for system-specific instructions.  Either in the
     75 [READMEdir directory](./READMEdir/) (in the repository) or
     76 the top directory (if you unpack an archive):
     77 
     78 ```
     79 README_ami.txt		Amiga
     80 README_unix.txt		Unix
     81 README_dos.txt		MS-DOS and MS-Windows
     82 README_mac.txt		Macintosh
     83 README_haiku.txt	Haiku
     84 README_vms.txt		VMS
     85 ```
     86 
     87 There are other `README_*.txt` files, depending on the distribution you used.
     88 
     89 ## Documentation
     90 
     91 The Vim tutor is a one hour training course for beginners.  Often it can be
     92 started as `vimtutor`.  See `:help tutor` for more information.
     93 
     94 The best is to use `:help` in Vim.  If you don't have an executable yet, read
     95 [`runtime/doc/help.txt`](./runtime/doc/help.txt).
     96 It contains pointers to the other documentation files.
     97 The User Manual reads like a book and is recommended to learn to use
     98 Vim.  See `:help user-manual`.
     99 
    100 ## Copying
    101 
    102 Vim is Charityware.  You can use and copy it as much as you like, but you are
    103 encouraged to make a donation to help orphans in Uganda.  Please read the file
    104 [`runtime/doc/uganda.txt`](./runtime/doc/uganda.txt)
    105 for details (do `:help uganda` inside Vim).
    106 
    107 Summary of the license: There are no restrictions on using or distributing an
    108 unmodified copy of Vim.  Parts of Vim may also be distributed, but the license
    109 text must always be included.  For modified versions, a few restrictions apply.
    110 The license is GPL compatible, you may compile Vim with GPL libraries and
    111 distribute it.
    112 
    113 ## Sponsoring
    114 
    115 Fixing bugs and adding new features takes a lot of time and effort.  To show
    116 your appreciation for the work and motivate developers to continue working on
    117 Vim please send a donation.
    118 
    119 The money you donated will be mainly used to help children in Uganda.  See
    120 [`runtime/doc/uganda.txt`](./runtime/doc/uganda.txt).  But at the same time
    121 donations increase the development team motivation to keep working on Vim!
    122 
    123 For the most recent information about sponsoring look on the Vim web site:
    124 	https://www.vim.org/sponsor/
    125 
    126 ## Contributing
    127 
    128 If you would like to help make Vim better, see the
    129 [CONTRIBUTING.md](./CONTRIBUTING.md) file.
    130 
    131 ## Information
    132 
    133 If you are on macOS, you can use [MacVim](https://macvim.org).
    134 
    135 The latest news about Vim can be found on the Vim home page:
    136 	https://www.vim.org/
    137 
    138 If you have problems, have a look at the Vim documentation or tips:
    139 	https://www.vim.org/docs.php
    140 	https://vim.fandom.com/wiki/Vim_Tips_Wiki
    141 
    142 If you still have problems or any other questions, use one of the mailing
    143 lists to discuss them with Vim users and developers:
    144 	https://www.vim.org/maillist.php
    145 
    146 If nothing else works, report bugs directly to the vim-dev mailing list:
    147 	`<vim-dev@vim.org>`
    148 
    149 ## Main author
    150 
    151 Most of Vim was created by Bram Moolenaar `<Bram@vim.org>`
    152 [Bram-Moolenaar](https://vimhelp.org/version9.txt.html#Bram-Moolenaar)
    153 
    154 Send any other comments, patches, flowers and suggestions to the vim-dev mailing list:
    155 	`<vim-dev@vim.org>`
    156 
    157 This is `README.md` for version 9.2 of Vim: Vi IMproved.