]> 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:

Ignore nonzero exit status of hg pull, which can happen when there were no changes...
[code/myrepos.git] / README
diff --git a/README b/README
index d16832f742b5b98f9c3e74c4eaaf5d80f757b94f..bd64ed7fbd80334b621adef2527ea780188f8ec3 100644 (file)
--- a/README
+++ b/README
@@ -1,16 +1,26 @@
-mr is a Multiple Repository management tool for Mercurial and Git
+mr is a Multiple Repository management tool for git, svn, mercurial, bzr,
+darcs, cvs, fossil and veracity.
 
 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
 
 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
-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.)
 
 
-Just copy mr into your PATH somewhere, if it isn't already, and set up
-~/.mrconfig
+To install mr, just copy mr into your PATH somewhere.
 
 
-----
+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.
 
 
-webcheckout has more dependencies, specifically the LWP::Simple and
-HTML::Parser CPAN modules, and optionally the URI module.
+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".
+
+For further details, and lots of configuration options, see the mr(1) man
+page.