Doc updates.
This commit is contained in:
parent
a0dc20dc52
commit
62b5fd8fc1
3 changed files with 21 additions and 34 deletions
26
README
26
README
|
@ -1,4 +1,4 @@
|
||||||
It's magit! Another Emacs mode for git.
|
It's magit! A Emacs mode for Git.
|
||||||
|
|
||||||
I wrote magit while learning about git and trying to figure out how I
|
I wrote magit while learning about git and trying 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
|
||||||
|
@ -7,16 +7,17 @@ it. Feedback is welcome!
|
||||||
|
|
||||||
* Installing
|
* Installing
|
||||||
|
|
||||||
Magit is in such an early stage that there is no support for
|
Magit can be installed with the popular recipe of
|
||||||
automatically installing it. To use magit without installing it, just
|
|
||||||
load magit.el into Emacs, in whatever way is most convenient for you.
|
|
||||||
|
|
||||||
For example, you could just add
|
$ ./configure
|
||||||
|
$ make install
|
||||||
|
|
||||||
(load ".../magit.el")
|
This will put magit.el into /usr/local/share/emacs/site-lisp, where
|
||||||
|
Emacs should be able to find it. Then add
|
||||||
|
|
||||||
to your ".emacs" file. You can load it into your running Emacs with
|
(require 'magit)
|
||||||
'M-x load-file'.
|
|
||||||
|
to your .emacs file.
|
||||||
|
|
||||||
* Getting started
|
* Getting started
|
||||||
|
|
||||||
|
@ -28,10 +29,11 @@ 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 with
|
help. You can read it in Emacs with 'C-u C-h i magit.info' for
|
||||||
|
example, or on the web at
|
||||||
|
|
||||||
* Updates
|
http://zagadka.vm.bytemark.co.uk/magit/magit.html
|
||||||
|
|
||||||
You can follow magit development by cloning
|
Magit's web home is currently at
|
||||||
|
|
||||||
http://zagadka.vm.bytemark.co.uk/git/magit.git/
|
http://zagadka.vm.bytemark.co.uk/magit/
|
||||||
|
|
4
magit.el
4
magit.el
|
@ -1,4 +1,4 @@
|
||||||
;;; magit -- control git from Emacs.
|
;;; magit -- control Git from Emacs.
|
||||||
|
|
||||||
;; Copyright (C) 2008 Marius Vollmer
|
;; Copyright (C) 2008 Marius Vollmer
|
||||||
;;
|
;;
|
||||||
|
@ -35,8 +35,6 @@
|
||||||
|
|
||||||
;; - Tags
|
;; - Tags
|
||||||
;; - 'Subsetting', only looking at a subset of all files.
|
;; - 'Subsetting', only looking at a subset of all files.
|
||||||
;; - Polish history browsing. Scroll when leaning on RET, etc.
|
|
||||||
;; - Indicate active command in modeline. Show progress in message area?
|
|
||||||
;; - Detect and handle renames and copies.
|
;; - Detect and handle renames and copies.
|
||||||
|
|
||||||
(require 'cl)
|
(require 'cl)
|
||||||
|
|
25
magit.texi
25
magit.texi
|
@ -29,21 +29,11 @@ Texts.
|
||||||
@end quotation
|
@end quotation
|
||||||
@end copying
|
@end copying
|
||||||
|
|
||||||
@titlepage
|
|
||||||
@title Magit User Manual
|
|
||||||
@author Marius Vollmer
|
|
||||||
@page
|
|
||||||
@vskip 0pt plus 1filll
|
|
||||||
@insertcopying
|
|
||||||
@end titlepage
|
|
||||||
|
|
||||||
@contents
|
|
||||||
|
|
||||||
@ifnottex
|
|
||||||
@node Top
|
@node Top
|
||||||
@top Magit User Manual
|
@top Magit User Manual
|
||||||
|
|
||||||
@end ifnottex
|
Magit is an interface to the version control system Git, implemented
|
||||||
|
as an extension to Emacs.
|
||||||
|
|
||||||
@menu
|
@menu
|
||||||
* Introduction::
|
* Introduction::
|
||||||
|
@ -58,17 +48,14 @@ Texts.
|
||||||
@node Introduction
|
@node Introduction
|
||||||
@chapter Introduction
|
@chapter Introduction
|
||||||
|
|
||||||
Magit is an interface to the distributed version control system Git,
|
|
||||||
implemented as an extension to Emacs.
|
|
||||||
|
|
||||||
With Magit, you can inspect and modify any number of Git repositories.
|
With Magit, you can inspect and modify any number of Git repositories.
|
||||||
You can review and commit the changes you have made to the tracked
|
You can review and commit the changes you have made to the tracked
|
||||||
files, for example, and you can browse the history of past changes.
|
files, for example, and you can browse the history of past changes.
|
||||||
|
|
||||||
Magit is not a complete interface to Git, it just makes using the most
|
Magit is not a complete interface to Git, it just makes the most
|
||||||
common Git command-line tools more convenient. Thus, while Magit is a
|
common Git command-line tools more convenient to use. Thus, while
|
||||||
good way to experiment with Git, using it will not save you from
|
Magit is a good way to experiment with Git, using it will not save you
|
||||||
learning Git itself.
|
from learning Git itself.
|
||||||
|
|
||||||
This manual provides a tour of all Magit features and short
|
This manual provides a tour of all Magit features and short
|
||||||
discussions of how you would typically use them together for simple
|
discussions of how you would typically use them together for simple
|
||||||
|
|
Loading…
Reference in a new issue