PJ Weisberg <[email protected]> writes: > On Sun, Apr 22, 2012 at 11:59 PM, Rémi Vanicat <[email protected]> wrote: >> From this discussion, it seem that we can have a better README. >> >> Could someone proofread this, as I'm no native speaker: >> >> diff --git a/README.md b/README.md >> index 4b6ac0b..91b23ff 100644 >> --- a/README.md >> +++ b/README.md >> @@ -16,16 +16,42 @@ demonstrates some of the major features. >> Installing >> ---------- >> >> -Download the latest tarball from [the github download page][download], >> -then Magit can be installed with the popular recipe of: >> +First, check if your distribution doesn't include a magit package, >> +and if its version suit you install it. > > I don't know if this is necessary. If I'm looking at this README then > I probably want to install *this* version of Magit. Or the latest one > from the site where I'm reading it.
Not sure, lot of people, particularly coming from windows, don't have the reflex to first look at their distribution's packages. Using its distribution package could be a better idea, because there will be update, and they will be installed automatically. That said I don't like the way I've wrote it. > >> -make && sudo make install >> +Otherwise download the latest tarball from >> +[the github download page][download], and choose if you want to >> +install it for all users of you computer, or in you home directory. >> >> -This requires `emacs` and `makeinfo` binaries, so please make sure the >> relevant >> -packages (generally `emacs` and `texinfo`) are installed on your system. >> -This will put magit.el into `/usr/local/share/emacs/site-lisp`, where >> -Emacs should be able to find it. Then add >> >> +### Installing Magit for all users >> + >> +Magit can be installed with the popular recipe of >> + >> + make && sudo make install >> + >> +This requires `emacs` and `makeinfo` binaries, so please make sure the >> +relevant packages (generally `emacs` and `texinfo`) are installed on >> +your system. This will put magit.el and others .el file into >> +`/usr/local/share/emacs/site-lisp`, where Emacs should be able to find >> +it. >> + >> +Users that will want to use it should then add >> + >> + (require 'magit) >> + >> +to their `.emacs` file. >> + >> +### Installing Magit in your home directory >> + >> +Copy the magit directory into ~/.emacs.d (or wherever you want it to >> +be), optionally run >> + >> + make >> + >> +in it to byte compile Magit. You will then have to add >> + >> + (add-to-list 'load-path "~/.emacs.d/magit") >> (require 'magit) >> >> to your `.emacs` file. > > Then you don't get the autoloads in 50magit.el (including > rebase-mode). And what about the contrib directory? rebase-mode is not in the 50magit.el of the maint branch. That said I agree that (add-to-list 'load-path "~/.emacs.d/magit") (load-file "50magit.el) is a better ending. But it mean than in the master branch I've to wrote something about generating 50magit.el. Well looking around show that We should wrote two version: one for the maint branch, one for the master branch, as the installation as changed since the last release. -- Rémi Vanicat
