blob: 060268e30322ccd58f9f813d36b1945a236d17d4 [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
7execute "vim tutor" and then follow the instructions in the lessons.
8The lessons tell you to modify the file, so DON'T DO THIS ON YOUR
9ORIGINAL COPY.
Bram Moolenaar071d4272004-06-13 20:20:40 +000010
Bram Moolenaarbadce652008-06-25 00:29:54 +000011On Unix you can also use the "vimtutor" program. It will make a
12scratch 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
Bram Moolenaara9604e62018-07-21 05:56:22 +020022
23Translation
24-----------
25
26The tutor.xx and tutor.xx.utf-8 files are translated files (where xx is the
Bram Moolenaar85850f32019-07-19 22:05:51 +020027language code). The encoding of tutor.xx might be latin1 or other traditional
Bram Moolenaara9604e62018-07-21 05:56:22 +020028encoding. If you don't need a translation with such traditional encoding,
29you just need to prepare the tutor.xx.utf-8 file.
30If you need another encoding, you can also prepare a file named tutor.xx.enc
31(replace enc with the actual encoding name). You might also need to adjust the
32tutor.vim file.
33The "make" command can be used for creating tutor.xx from tutor.xx.utf-8.
34See the Makefile for detail. (For some languages, tutor.xx.utf-8 is created
35from tutor.xx for historical reasons.)
36
37[This file was modified for Vim by Bram Moolenaar et al.]