Add a README in the contrib/emacs directory.
Signed-off-by: Alexandre Julliard <julliard@winehq.org>
Alexandre Julliard committed
Feb 16, 2009 at 11:40 UTC
6f3c504b54e93772e875b6210fe69ecbad978e78
1 file changed
+39
contrib/emacs/README
new
+39
@@ -0,0 +1,39 @@
1
+This directory contains various modules for Emacs support.
2
+
3
+To make the modules available to Emacs, you should add this directory
4
+to your load-path, and then require the modules you want. This can be
5
+done by adding to your .emacs something like this:
6
+
7
+ (add-to-list 'load-path ".../git/contrib/emacs")
8
+ (require 'git)
9
+ (require 'git-blame)
10
+
11
+
12
+The following modules are available:
13
+
14
+* git.el:
15
+
16
+ Status manager that displays the state of all the files of the
17
+ project, and provides easy access to the most frequently used git
18
+ commands. The user interface is as far as possible compatible with
19
+ the pcl-cvs mode. It can be started with `M-x git-status'.
20
+
21
+* git-blame.el:
22
+
23
+ Emacs implementation of incremental git-blame. When you turn it on
24
+ while viewing a file, the editor buffer will be updated by setting
25
+ the background of individual lines to a color that reflects which
26
+ commit it comes from. And when you move around the buffer, a
27
+ one-line summary will be shown in the echo area.
28
+
29
+* vc-git.el:
30
+
31
+ This file used to contain the VC-mode backend for git, but it is no
32
+ longer distributed with git. It is now maintained as part of Emacs
33
+ and included in standard Emacs distributions starting from version
34
+ 22.2.
35
+
36
+ If you have an earlier Emacs version, upgrading to Emacs 22 is
37
+ recommended, since the VC mode in older Emacs is not generic enough
38
+ to be able to support git in a reasonable manner, and no attempt has
39
+ been made to backport vc-git.el.