Mercurial > vim
annotate README.txt @ 18100:df5778d73320 v8.1.2045
patch 8.1.2045: the option.c file is too big
Commit: https://github.com/vim/vim/commit/dac1347b4d9c1a1aef6aa73fdea08a9d1077d6ea
Author: Bram Moolenaar <Bram@vim.org>
Date: Mon Sep 16 21:06:21 2019 +0200
patch 8.1.2045: the option.c file is too big
Problem: The option.c file is too big.
Solution: Split off the code dealing with strings. (Yegappan Lakshmanan,
closes #4937)
author | Bram Moolenaar <Bram@vim.org> |
---|---|
date | Mon, 16 Sep 2019 21:15:05 +0200 |
parents | 1174611ad715 |
children | af69c9335223 |
rev | line source |
---|---|
13963 | 1 README.txt for version 8.1 of Vim: Vi IMproved. |
0 | 2 |
3 | |
7177
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
4 WHAT IS VIM? |
0 | 5 |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
6 Vim is a greatly improved version of the good old UNIX editor Vi. Many new |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
7 features have been added: multi-level undo, syntax highlighting, command line |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
8 history, on-line help, spell checking, filename completion, block operations, |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
9 script language, etc. There is also a Graphical User Interface (GUI) |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
10 available. Still, Vi compatibility is maintained, those who have Vi "in the |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
11 fingers" will feel at home. See "runtime/doc/vi_diff.txt" for differences with |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
12 Vi. |
0 | 13 |
2564
f85004953416
README and help file updates.
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
14 This editor is very useful for editing programs and other plain text files. |
0 | 15 All commands are given with normal keyboard characters, so those who can type |
16 with ten fingers can work very fast. Additionally, function keys can be | |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
17 mapped to commands by the user, and the mouse can be used. |
0 | 18 |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
19 Vim runs under MS-Windows (NT, 2000, XP, Vista, 7, 8, 10), Macintosh, VMS and |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
20 almost all flavours of UNIX. Porting to other systems should not be very |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
21 difficult. Older versions of Vim run on MS-DOS, MS-Windows 95/98/Me, Amiga |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
22 DOS, Atari MiNT, BeOS, RISC OS and OS/2. These are no longer maintained. |
0 | 23 |
24 | |
25 DISTRIBUTION | |
26 | |
7177
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
27 You can often use your favorite package manager to install Vim. On Mac and |
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
28 Linux a small version of Vim is pre-installed, you still need to install Vim |
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
29 if you want more features. |
c4d677c50b9b
commit https://github.com/vim/vim/commit/c92399f4ee6d0289dbe5d708d14a84e32f617bd5
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
30 |
0 | 31 There are separate distributions for Unix, PC, Amiga and some other systems. |
32 This README.txt file comes with the runtime archive. It includes the | |
33 documentation, syntax files and other files that are used at runtime. To run | |
34 Vim you must get either one of the binary archives or a source archive. | |
35 Which one you need depends on the system you want to run it on and whether you | |
36 want or must compile it yourself. Check "http://www.vim.org/download.php" for | |
37 an overview of currently available distributions. | |
38 | |
8917
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
39 Some popular places to get the latest Vim: |
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
40 * Check out the git repository from github: https://github.com/vim/vim. |
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
41 * Get the source code as an archive: https://github.com/vim/vim/releases. |
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
42 * Get a Windows executable from the vim-win32-installer repository: |
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
43 https://github.com/vim/vim-win32-installer/releases. |
d07e51166f08
commit https://github.com/vim/vim/commit/5d98c9d93278d6961bfee59151666b8a8bcd23c3
Christian Brabandt <cb@256bit.org>
parents:
8791
diff
changeset
|
44 |
0 | 45 |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
46 COMPILING |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
47 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
48 If you obtained a binary distribution you don't need to compile Vim. If you |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
49 obtained a source distribution, all the stuff for compiling Vim is in the |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
50 "src" directory. See src/INSTALL for instructions. |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
51 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
52 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
53 INSTALLATION |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
54 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
55 See one of these files for system-specific instructions. Either in the |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
56 READMEdir directory (in the repository) or the top directory (if you unpack an |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
57 archive): |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
58 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
59 README_ami.txt Amiga |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
60 README_unix.txt Unix |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
61 README_dos.txt MS-DOS and MS-Windows |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
62 README_mac.txt Macintosh |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
63 README_vms.txt VMS |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
64 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
65 There are more README_*.txt files, depending on the distribution you used. |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
66 |
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
67 |
0 | 68 DOCUMENTATION |
69 | |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
70 The Vim tutor is a one hour training course for beginners. Often it can be |
2564
f85004953416
README and help file updates.
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
71 started as "vimtutor". See ":help tutor" for more information. |
f85004953416
README and help file updates.
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
72 |
0 | 73 The best is to use ":help" in Vim. If you don't have an executable yet, read |
74 "runtime/doc/help.txt". It contains pointers to the other documentation | |
75 files. The User Manual reads like a book and is recommended to learn to use | |
76 Vim. See ":help user-manual". | |
77 | |
78 | |
79 COPYING | |
80 | |
81 Vim is Charityware. You can use and copy it as much as you like, but you are | |
2564
f85004953416
README and help file updates.
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
82 encouraged to make a donation to help orphans in Uganda. Please read the file |
0 | 83 "runtime/doc/uganda.txt" for details (do ":help uganda" inside Vim). |
84 | |
85 Summary of the license: There are no restrictions on using or distributing an | |
86 unmodified copy of Vim. Parts of Vim may also be distributed, but the license | |
87 text must always be included. For modified versions a few restrictions apply. | |
88 The license is GPL compatible, you may compile Vim with GPL libraries and | |
89 distribute it. | |
90 | |
91 | |
92 SPONSORING | |
93 | |
826 | 94 Fixing bugs and adding new features takes a lot of time and effort. To show |
95 your appreciation for the work and motivate Bram and others to continue | |
96 working on Vim please send a donation. | |
0 | 97 |
826 | 98 Since Bram is back to a paid job the money will now be used to help children |
99 in Uganda. See runtime/doc/uganda.txt. But at the same time donations | |
100 increase Bram's motivation to keep working on Vim! | |
0 | 101 |
102 For the most recent information about sponsoring look on the Vim web site: | |
826 | 103 |
0 | 104 http://www.vim.org/sponsor/ |
105 | |
106 | |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
107 CONTRIBUTING |
0 | 108 |
8791
43b5ff7837ea
commit https://github.com/vim/vim/commit/d18cfb7dbfd32af729d3ac5136f77dcdbefe5dee
Christian Brabandt <cb@256bit.org>
parents:
7437
diff
changeset
|
109 If you would like to help making Vim better, see the CONTRIBUTING.md file. |
2564
f85004953416
README and help file updates.
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
110 |
0 | 111 |
112 INFORMATION | |
113 | |
114 The latest news about Vim can be found on the Vim home page: | |
115 http://www.vim.org/ | |
116 | |
6918 | 117 If you have problems, have a look at the Vim documentation or tips: |
118 http://www.vim.org/docs.php | |
119 http://vim.wikia.com/wiki/Vim_Tips_Wiki | |
0 | 120 |
3941 | 121 If you still have problems or any other questions, use one of the mailing |
122 lists to discuss them with Vim users and developers: | |
3935 | 123 http://www.vim.org/maillist.php |
124 | |
125 If nothing else works, report bugs directly: | |
0 | 126 Bram Moolenaar <Bram@vim.org> |
127 | |
128 | |
129 MAIN AUTHOR | |
130 | |
2502
e6420d275b6a
Update README files. Remove references to extra and lang archives.
Bram Moolenaar <bram@vim.org>
parents:
2490
diff
changeset
|
131 Send any other comments, patches, flowers and suggestions to: |
0 | 132 |
133 Bram Moolenaar E-mail: Bram@vim.org |