Try to create a HACKING link in README.md.

[bup.git] / README.md

diff --git a/README.md b/README.md
index 04819073d090edf786c82a95558079b8aad2e353..e766558c934b31cbab71695a90ec99ad6f8df8cc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -92,18 +92,33 @@ From source
         git clone git://github.com/apenwarr/bup
 
  - Install the needed python libraries (including the development
-   libraries).  On Debian or Ubuntu, this is usually:
-        apt-get install python2.6-dev python-fuse
-        apt-get install python-pyxattr python-pylibacl
-        
-    Substitute python2.5-dev or python2.4-dev if you have an older system.
-    
-    Or on newer Debian/Ubuntu versions, you can try this:
+   libraries).
+
+   On Debian/Ubuntu this is usually sufficient (run as root):
+
+            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
+   this:
     
-        apt-get build-dep bup
-       
+            apt-get build-dep bup
+
+   On CentOS (for CentOS 6, at least), this should be sufficient (run
+   as root):
+
+            yum groupinstall "Development Tools"
+            yum install python python-dev
+            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
        
  - Run the tests:
@@ -113,6 +128,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
 --------------------
@@ -300,10 +324,16 @@ Things that are stupid for now but which we'll fix later
 Help with any of these problems, or others, is very welcome.  Join the
 mailing list (see below) if you'd like to help.
 
- - 'bup save' and 'bup restore' don't know about file metadata.
+ - 'bup save' and 'bup restore' have immature metadata support.
  
-    That means we aren't saving file attributes, mtimes, ownership, hard
-    links, MacOS resource forks, etc.  Clearly this needs to be improved.
+    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.
+
+    In addition, at the moment, if any strip or graft-style options
+    are specified to 'bup save', then no metadata will be written for
+    the root directory.  That's obviously less than ideal.
 
  - 'bup index' is slower than it should be.
  
@@ -367,6 +397,8 @@ bup has an extensive set of man pages.  Try using 'bup help' to get
 started, or use 'bup help SUBCOMMAND' for any bup subcommand (like split,
 join, index, save, etc.) to get details on that command.
 
+For further technical details, please see ./DESIGN.
+
 
 How you can help
 ================
@@ -383,6 +415,11 @@ and you can subscribe by sending a message to:
 
        bup-list+subscribe@googlegroups.com
 
+Please see <a href="bup/HACKING">./HACKING</a> for additional
+information, i.e. how to submit patches (hint - no pull requests), how
+we handle branches, etc.
+
+
 Have fun,
 
 Avery