]> git.madduck.net Git - code/myrepos.git/blobdiff - README

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Fix display of trust errors.
[code/myrepos.git] / README
diff --git a/README b/README
index c3ecae5949a77a88f4409ab441389daa1d97fc67..5cb7e133e4ed021c144470937bc2e37d16aac113 100644 (file)
--- a/README
+++ b/README
@@ -1,11 +1,26 @@
+mr is a Multiple Repository management tool for git, svn, mercurial, bzr,
+darcs, cvs, and fossil.
+
+Author: Joey Hess
+Homepage: http://kitenet.net/~joey/code/mr/
+
 mr is intended to be very self-contained, since it might be useful to check
 it into ~/bin when keeping your home in version control. It has no
 mr is intended to be very self-contained, since it might be useful to check
 it into ~/bin when keeping your home in version control. It has no
-dependencies aside from basic perl.
+dependencies aside from basic perl. (The included webcheckout command has
+more dependencies, specifically the LWP::Simple and HTML::Parser CPAN
+modules, and optionally the URI module.)
+
+To install mr, just copy mr into your PATH somewhere.
 
 
-Just copy mr into your PATH somewhere, if it isn't already, and set up
-~/.mrconfig
+To get started using mr, perhaps you already have some checked out
+repositories. Go into each one and run "mr register". Now mr has
+a list of them in ~/.mrconfig, which you can edit later to tune its
+operation.
 
 
-----
+Suppose you've cd'd to ~/src, and it has many repositories under it.
+To update them all, run "mr update". To commit any pending changes in
+each, run "mr commit". To check the status of each, you could run
+"mr status".
 
 
-webcheckout has more dependencies, specifically the LWP::Simple and
-HTML::Parser CPAN modules, and optionally the URI module.
+For further details, and lots of configuration options, see the mr(1) man
+page.