slackbuilds/README.md
Ævar Arnfjörð Bjarmason ed6d791c61 Make magit's README file better
* Rewrite the intro, the old one wasn't really applicable anymore.

  * Use Markdown to its fullest, the old links were really confusing.

  * More links, link prominently to the manual, screencast and
    cheatsheet.
2010-05-18 00:17:30 +08:00

1.9 KiB

It's Magit! A Emacs mode for Git.

Magit is an interface to Git for Emacs. Unlike Emacs's native version control support, Magit can take advantage of Git's native features without breaking compatibility with other systems.

To get started see the Magit User Manual or perhaps the cheatsheet if you're in a hurry. There's also an excellent Magit screencast by Alex Vollmer which demonstrates some of the major features.

Installing

Download the latest tarball from the github download page.

And then 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 short help for 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, or on the web.

If you have any questions, please use the mailing list at Google Groups.

Magit's website is currently hosted on GitHub.