Markdown'd the README.

This commit is contained in:
Phil Jackson 2010-05-07 21:00:49 +01:00
parent cb458d5918
commit d74beb91ee

View file

@ -1,11 +1,16 @@
It's Magit! A Emacs mode for Git. It's Magit! A Emacs mode for Git.
==================================
I started to write Magit to learn about Git and to figure out how I 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 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 become more coherent as I learn more about Git and good ways to use
it. Feedback is welcome! 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 Magit can be installed with the popular recipe of
@ -20,14 +25,16 @@ Emacs should be able to find it. Then add
to your .emacs file. to your .emacs file.
* Getting started Getting started
---------------
To get started with Magit, open any file in a Git repository in Emacs 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 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 m' in the Magit buffer), make some changes to your files, and try to
commit them. commit them.
* Learning more Learning more
-------------
The Magit User Manual describes things with more words than the online 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 help. You can read it in Emacs with 'C-u C-h i magit.info' for