Merge branch 'master' into meta

[bup.git] / README.md

diff --git a/README.md b/README.md
index b6859c1459d3db7709b8d69958eb2a1af9744a10..acc5e533cab901abbc127e417932b3b2f97ff115 100644 (file)
--- a/README.md
+++ b/README.md
@@ -75,12 +75,17 @@ Reasons you might want to avoid bup
  - It requires python >= 2.4, a C compiler, and an installed git version >=
    1.5.3.1.
  
- - It currently only works on Linux, MacOS X >= 10.4, or Windows (with
-   Cygwin).  Patches to support other platforms are welcome.
+ - It currently only works on Linux, MacOS X >= 10.4,
+   Solaris, or Windows (with Cygwin).  Patches to support
+   other platforms are welcome.
    
    
 Getting started
----------------
+===============
+
+
+From source
+-----------
 
  - Check out the bup source code using git:
  
@@ -89,8 +94,13 @@ Getting started
  - 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:
+    
+        apt-get build-dep bup
        
  - Build the python module and symlinks:
  
@@ -102,7 +112,23 @@ Getting started
        
     (The tests should pass.  If they don't pass for you, stop here and send
     me an email.)
-   
+
+
+From binary packages
+--------------------
+
+Binary packages of bup are known to be built for the following OSes:
+
+ - Debian:
+    http://packages.debian.org/search?searchon=names&keywords=bup
+ - Ubuntu:
+    http://packages.ubuntu.com/search?searchon=names&keywords=bup
+ - NetBSD
+
+
+Using bup
+---------
+
  - Try making a local backup as a tar file:
  
         tar -cvf - /etc | bup split -n local-etc -vv
@@ -164,8 +190,29 @@ Getting started
 That's all there is to it!
 
 
+Notes on FreeBSD
+----------------
+
+- FreeBSD's default 'make' command doesn't like bup's Makefile. In order to
+  compile the code, run tests and install bup, you need to install GNU Make
+  from the port named 'gmake' and use its executable instead in the commands
+  seen above. (i.e. 'gmake test' runs bup's test suite)
+
+- Python's development headers are automatically installed with the 'python'
+  port so there's no need to install them separately.
+
+- To use the 'bup fuse' command, you need to install the fuse kernel module
+  from the 'fusefs-kmod' port in the 'sysutils' section and the libraries from
+  the port named 'py-fusefs' in the 'devel' section.
+
+- The 'par2' command can be found in the port named 'par2cmdline'.
+
+- In order to compile the documentation, you need pandoc which can be found in
+  the port named 'hs-pandoc' in the 'textproc' section.
+
+
 How it works
-------------
+============
 
 Basic storage:
 
@@ -299,7 +346,7 @@ join, index, save, etc.) to get details on that command.
 
 
 How you can help
-----------------
+================
 
 bup is a work in progress and there are many ways it can still be improved.
 If you'd like to contribute patches, ideas, or bug reports, please join the