Skip to content

Commit 4d505ad

Browse files
splhacksplhack
committed
Merge pull request #265 from macvim-dev/feature/README
MacVim README.md
2 parents 130eee0 + 0fffd1c commit 4d505ad

2 files changed

Lines changed: 139 additions & 133 deletions

File tree

‎README.md‎

Lines changed: 3 additions & 133 deletions
Original file line numberDiff line numberDiff line change
@@ -1,136 +1,6 @@
1-
`README.md` for version 7.4 of Vim: Vi IMproved.
2-
[![Build Status](https://travis-ci.org/vim/vim.svg?branch=master)](https://travis-ci.org/vim/vim)
3-
[![Coverage Status](https://coveralls.io/repos/vim/vim/badge.svg?branch=master&service=github)](https://coveralls.io/github/vim/vim?branch=master)
4-
[![Appveyor Build status](https://ci.appveyor.com/api/projects/status/o2qht2kjm02sgghk?svg=true)](https://ci.appveyor.com/project/chrisbra/vim)
5-
[![Coverity Scan](https://scan.coverity.com/projects/241/badge.svg)](https://scan.coverity.com/projects/vim)
1+
Vim - the text editor - for Mac OS X
62

3+
- MacVim homepage http://macvim-dev.github.io/macvim
74

8-
## What is Vim? ##
5+
- Vim README https://github.com/macvim-dev/macvim/blob/master/README_vim.md
96

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

‎README_vim.md‎

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

0 commit comments

Comments
 (0)