Attempt to fix HACKING link in README.md.

[bup.git] / README.md

diff --git a/README.md b/README.md
index 5a81716f0093fa0fbc89ba121fee12e061d979d4..29b096e8daec55ccb6664f61f6720326a68cb549 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,3 @@
-
 bup: It backs things up
 =======================
 
@@ -89,7 +88,7 @@ From source
 
  - Check out the bup source code using git:
  
-        git clone git://github.com/apenwarr/bup
+        git clone git://github.com/bup/bup
 
  - Install the needed python libraries (including the development
    libraries).
@@ -98,6 +97,7 @@ From source
 
             apt-get install python2.6-dev python-fuse
             apt-get install python-pyxattr python-pylibacl
+            apt-get install linux-libc-dev
 
    Substitute python2.5-dev or python2.4-dev if you have an older
    system.  Alternately, on newer Debian/Ubuntu versions, you can try
@@ -113,6 +113,9 @@ From source
             yum install fuse-python pyxattr pylibacl
             yum install perl-Time-HiRes
 
+   In addition to the default CentOS repositories, you may need to add
+   RPMForge (for fuse-python) and EPEL (for pyxattr and pylibacl).
+
  - Build the python module and symlinks:
 
         make
@@ -124,6 +127,15 @@ From source
     (The tests should pass.  If they don't pass for you, stop here and send
     me an email.)
 
+ - You can install bup via "make install", and override the default
+   destination with DESTDIR and PREFIX.
+
+   Files are normally installed to "$DESTDIR/$PREFIX" where DESTDIR is
+   empty by default, and PREFIX is set to /usr.  So if you wanted to
+   install bup to /opt/bup, you might do something like this:
+
+        make install DESTDIR=/opt/bup PREFIX=''
+
 
 From binary packages
 --------------------
@@ -315,8 +327,8 @@ mailing list (see below) if you'd like to help.
  
     On the plus side, they actually do have support now, but it's new,
     and not remotely as well tested as tar/rsync/whatever's.  If you'd
-    like to help test, please do; something like 'rsync -niaHAX src/
-    restore/' may be useful on that front.
+    like to help test, please do (see t/compare-trees for one
+    comparison method).
 
     In addition, at the moment, if any strip or graft-style options
     are specified to 'bup save', then no metadata will be written for
@@ -402,6 +414,11 @@ and you can subscribe by sending a message to:
 
        bup-list+subscribe@googlegroups.com
 
+Please see <a href="HACKING">./HACKING</a> for
+additional information, i.e. how to submit patches (hint - no pull
+requests), how we handle branches, etc.
+
+
 Have fun,
 
 Avery