README.md: add Cygwin dependencies.

[bup.git] / README.md

diff --git a/README.md b/README.md
index b3a937e6514e70d58f1257876d80bde11cf1fd5f..46b4e7a0d26f677c8cedad3b6c5fea55de9b56da 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,3 @@
-
 bup: It backs things up
 =======================
 
@@ -72,7 +71,7 @@ Reasons you might want to avoid bup
    for you, but we don't know why.  It is also missing some
    probably-critical features.
    
- - It requires python >= 2.4, a C compiler, and an installed git version >=
+ - It requires python >= 2.5, a C compiler, and an installed git version >=
    1.5.3.1.
  
  - It currently only works on Linux, MacOS X >= 10.4,
@@ -89,21 +88,37 @@ 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).  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 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).
+
+   On Cygwin, install python, make, rsync, and gcc4.
+
  - 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
 --------------------
@@ -234,6 +258,13 @@ Notes on NetBSD/pkgsrc
    anything useful.
 
 
+Notes on Cygwin
+---------------
+
+ - There is no support for ACLs.  If/when some entrprising person
+   fixes this, adjust t/compare-trees.
+
+
 How it works
 ============
 
@@ -300,10 +331,35 @@ 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 (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
+    the root directory.  That's obviously less than ideal.
+
+ - bup is overly optimistic about mmap.  Right now bup just assumes
+   that it can mmap as large a block as it likes, and that mmap will
+   never fail.  Yeah, right... If nothing else, this has failed on
+   32-bit architectures (and 31-bit is even worse -- looking at you,
+   s390).
+
+   To fix this, we might just implement a FakeMmap[1] class that uses
+   normal file IO and handles all of the mmap methods[2] that bup
+   actually calls.  Then we'd swap in one of those whenever mmap
+   fails.
+
+   This would also require implementing some of the methods needed to
+   support "[]" array access, probably at a minimum __getitem__,
+   __setitem__, and __setslice__ [3].
+
+     [1] http://comments.gmane.org/gmane.comp.sysutils.backup.bup/613
+     [2] http://docs.python.org/2/library/mmap.html
+     [3] http://docs.python.org/2/reference/datamodel.html#emulating-container-types
 
  - 'bup index' is slower than it should be.
  
@@ -385,6 +441,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