From d74beb91ee95949534499ce34b6a32fde3120cc8 Mon Sep 17 00:00:00 2001 From: Phil Jackson Date: Fri, 7 May 2010 21:00:49 +0100 Subject: [PATCH] Markdown'd the README. --- README => README.md | 27 +++++++++++++++++---------- 1 file changed, 17 insertions(+), 10 deletions(-) rename README => README.md (64%) diff --git a/README b/README.md similarity index 64% rename from README rename to README.md index b3e41d3b..b0431494 100644 --- a/README +++ b/README.md @@ -1,44 +1,51 @@ 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 is owned by Marius Vollmer and is currently maintained by Phil +Jackson. For a full list of contributors have a look at magit.el. + +Installing +---------- Magit can be installed with the popular recipe of - $ ./autogen.sh # If you got the sources directly from Git - $ ./configure - $ make install + $ ./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) + (require 'magit) to your .emacs file. -* Getting started +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 +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 + 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/ + http://groups.google.com/group/magit/ Magit's web home is currently at - http://zagadka.vm.bytemark.co.uk/magit/ + http://zagadka.vm.bytemark.co.uk/magit/