blob: a8b48a4058f6e89b1a25c6820b1da13edf02a42a [file] [log] [blame]
Bram Moolenaarbadce652008-06-25 00:29:54 +00001Tutor is a "hands on" tutorial for new users of the Vim editor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
Bram Moolenaarbadce652008-06-25 00:29:54 +00003Most new users can get through it in less than one hour. The result
4is that you can do a simple editing task using the Vim editor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005
Bram Moolenaarbadce652008-06-25 00:29:54 +00006Tutor is a file that contains the tutorial lessons. You can simply
RestorerZ6fa304f2024-12-02 20:19:52 +01007execute "vim tutor1" and then follow the instructions in the lessons.
Bram Moolenaarbadce652008-06-25 00:29:54 +00008The lessons tell you to modify the file, so DON'T DO THIS ON YOUR
9ORIGINAL COPY.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010
RestorerZ6fa304f2024-12-02 20:19:52 +010011On UNIX-like systems you can also use the "vimtutor" program.
12It will make a scratch copy of the tutor first.
Bram Moolenaar071d4272004-06-13 20:20:40 +000013
Bram Moolenaarbadce652008-06-25 00:29:54 +000014I have considered adding more advanced lessons but have not found the
15time. Please let me know how you like it and send any improvements you
16make.
Bram Moolenaar071d4272004-06-13 20:20:40 +000017
Bram Moolenaarbadce652008-06-25 00:29:54 +000018Bob Ware, Colorado School of Mines, Golden, Co 80401, USA
19(303) 273-3987
20bware@mines.colorado.edu bware@slate.mines.colorado.edu bware@mines.bitnet
Bram Moolenaar071d4272004-06-13 20:20:40 +000021
RestorerZ6fa304f2024-12-02 20:19:52 +010022All of the above regarding chapter one of the tutorial also applies to chapter
23two of the tutorial. Except that you must use the command “vim tutor2” to open
24chapter two.
25
26The chapter two of the tutorial was written by Paul D. Parker.
Bram Moolenaara9604e62018-07-21 05:56:22 +020027
28Translation
29-----------
RestorerZ6fa304f2024-12-02 20:19:52 +010030The files tutor1.xx and tutor1.xx.utf-8 for chapter one and tutor2.xx and
31tutor2.xx.utf-8 for chapter two of the tutorial are translated files (where xx
32is the language code).
33The encoding of tutor1.xx or tutor2.xx might be latin1 or other traditional
Bram Moolenaara9604e62018-07-21 05:56:22 +020034encoding. If you don't need a translation with such traditional encoding,
RestorerZ6fa304f2024-12-02 20:19:52 +010035you just need to prepare the tutor1.xx.utf-8 or tutor2.xx.utf-8 file.
36If you need another encoding, you can also prepare a file named tutor1.xx.enc or
37tutor2.xx.enc (replace enc with the actual encoding name). You might also need
38to adjust the tutor.vim file.
39The "make" command can be used for creating tutor1.xx or tutor2.xx from
40tutor.xx.utf-8 or tutor2.xx.utf-8, respectively.
41See the Makefile for detail. (For some languages, tutor1.xx.utf-8 is created
42from tutor1.xx for historical reasons.)
Bram Moolenaara9604e62018-07-21 05:56:22 +020043
44[This file was modified for Vim by Bram Moolenaar et al.]