From 08de8c72b1799380f6e645108a68f37e014fcfea Mon Sep 17 00:00:00 2001 From: Marius Vollmer Date: Tue, 12 Aug 2008 04:31:07 +0300 Subject: [PATCH] Added README, AUTHORS, and NEWS. --- AUTHORS | 1 + NEWS | 1 + README | 37 +++++++++++++++++++++++++++++++++++++ magit.el | 2 ++ 4 files changed, 41 insertions(+) create mode 100644 AUTHORS create mode 100644 NEWS create mode 100644 README diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 00000000..f59002b0 --- /dev/null +++ b/AUTHORS @@ -0,0 +1 @@ +Marius Vollmer diff --git a/NEWS b/NEWS new file mode 100644 index 00000000..4c713bdb --- /dev/null +++ b/NEWS @@ -0,0 +1 @@ +(Magit has not been released yet, so there are no release notes.) diff --git a/README b/README new file mode 100644 index 00000000..48142be6 --- /dev/null +++ b/README @@ -0,0 +1,37 @@ +It's magit! Another Emacs mode for git. + +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 +become more coherent as I learn more about git and good ways to use +it. Feedback is welcome! + +* Installing + +Magit is in such an early stage that there is no support for +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 + + (load ".../magit.el") + +to your ".emacs" file. You can load it into your running Emacs with +'M-x load-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 with + +* Updates + +You can follow magit development by cloning + + http://zagadka.vm.bytemark.co.uk/git/magit.git/ diff --git a/magit.el b/magit.el index 3b9782e2..a7a5ea4b 100644 --- a/magit.el +++ b/magit.el @@ -28,6 +28,8 @@ ;; tree and the index, and the difference between the index and the ;; current HEAD. You can add individual hunks from the working tree ;; to the index, and you can commit the index. +;; +;; See the Magit User Guide for more information. ;;; TODO