summaryrefslogtreecommitdiffstats
path: root/emacs.d/lisp/magit/README
diff options
context:
space:
mode:
Diffstat (limited to 'emacs.d/lisp/magit/README')
-rw-r--r--emacs.d/lisp/magit/README44
1 files changed, 44 insertions, 0 deletions
diff --git a/emacs.d/lisp/magit/README b/emacs.d/lisp/magit/README
new file mode 100644
index 0000000..b3e41d3
--- /dev/null
+++ b/emacs.d/lisp/magit/README
@@ -0,0 +1,44 @@
+It's Magit! A Emacs mode for Git.
+
+I started to write Magit to learn about Git and to figure out how I
+would be using Git in a 'natural' way. Magit will grow and hopefully
+become more coherent as I learn more about Git and good ways to use
+it. Feedback is welcome!
+
+* Installing
+
+Magit can be installed with the popular recipe of
+
+ $ ./autogen.sh # If you got the sources directly from Git
+ $ ./configure
+ $ make install
+
+This will put magit.el into /usr/local/share/emacs/site-lisp, where
+Emacs should be able to find it. Then add
+
+ (require 'magit)
+
+to your .emacs file.
+
+* Getting started
+
+To get started with Magit, open any file in a Git repository in Emacs
+and run 'M-x magit-status'. Read the online help of magit-mode ('C-h
+m' in the Magit buffer), make some changes to your files, and try to
+commit them.
+
+* Learning more
+
+The Magit User Manual describes things with more words than the online
+help. You can read it in Emacs with 'C-u C-h i magit.info' for
+example, or on the web at
+
+ http://zagadka.vm.bytemark.co.uk/magit/magit.html
+
+If you have questions, please use the mailing list at
+
+ http://groups.google.com/group/magit/
+
+Magit's web home is currently at
+
+ http://zagadka.vm.bytemark.co.uk/magit/