configure.inc: name the tmpdir with a configure- prefix

[bup.git] / README.md

diff --git a/README.md b/README.md
index 4521e30f9c055c6fd6afdbfdc01014e8ca2ab421..aabd4b3c7f36ead095022c79ea1c619097deac69 100644 (file)
--- a/README.md
+++ b/README.md
@@ -67,12 +67,12 @@ bup has a few advantages over other backup software:
 Reasons you might want to avoid bup
 -----------------------------------
 
 Reasons you might want to avoid bup
 -----------------------------------
 

- - This is a very early version. Therefore it will most probably not work
-   for you, but we don't know why.  It is also missing some
-   probably-critical features.
+ - It's not remotely as well tested as something like tar, so it's
+   more likely to eat your data.  It's also missing some
+   probably-critical features, though fewer than it used to be.

    
  - It requires python >= 2.6, a C compiler, and an installed git
    
  - It requires python >= 2.6, a C compiler, and an installed git

-   version >= 1.5.3.1.  It also requires par2 if you want fsck to be
+   version >= 1.5.6.  It also requires par2 if you want fsck to be

    able to generate the information needed to recover from some types
    of corruption.
  
    able to generate the information needed to recover from some types
    of corruption.
  


@@ -86,6 +86,7 @@ Reasons you might want to avoid bup
 Notable changes introduced by a release
 =======================================
 
 Notable changes introduced by a release
 =======================================
 

+ - <a href="note/0.29.2-from-0.29.1.md">Changes in 0.29.2 as compared to 0.29.1</a>

  - <a href="note/0.29.1-from-0.29.md">Changes in 0.29.1 as compared to 0.29</a>
  - <a href="note/0.29-from-0.28.1.md">Changes in 0.29 as compared to 0.28.1</a>
  - <a href="note/0.28.1-from-0.28.md">Changes in 0.28.1 as compared to 0.28</a>
  - <a href="note/0.29.1-from-0.29.md">Changes in 0.29.1 as compared to 0.29</a>
  - <a href="note/0.29-from-0.28.1.md">Changes in 0.29 as compared to 0.28.1</a>
  - <a href="note/0.28.1-from-0.28.md">Changes in 0.28.1 as compared to 0.28</a>


@@ -153,7 +154,11 @@ From source
        
  - Run the tests:
  
        
  - Run the tests:
  

-        make test
+        make long-check
+
+    or if you're in a bit more of a hurry:
+
+        make check

        
     The tests should pass.  If they don't pass for you, stop here and
     send an email to bup-list@googlegroups.com.  Though if there are
        
     The tests should pass.  If they don't pass for you, stop here and
     send an email to bup-list@googlegroups.com.  Though if there are


@@ -209,7 +214,9 @@ Using bup
         bup help restore
         ...
 
         bup help restore
         ...
 

- - Initialize the default BUP_DIR (~/.bup):
+ - Initialize the default BUP_DIR (~/.bup -- you can choose another by
+   either specifying `bup -d DIR ...` or setting the `BUP_DIR`
+   environment variable for a command):

 
         bup init
 
 
         bup init
 


@@ -296,7 +303,7 @@ Using bup
  - Look at how little extra space your second backup used on top of
    the first:
  
  - Look at how little extra space your second backup used on top of
    the first:
  

-       du -s ~/.bup
+        du -s ~/.bup

        
  - Restore the first tar backup again (the ~1 is git notation for "one
    older than the most recent"):
        
  - Restore the first tar backup again (the ~1 is git notation for "one
    older than the most recent"):


@@ -517,7 +524,7 @@ mailing list (see below) if you'd like to help.
     
  - bup needs better documentation.
  
     
  - bup needs better documentation.
  

-    According to a recent article about bup in Linux Weekly News
+    According to an article about bup in Linux Weekly News

     (https://lwn.net/Articles/380983/), "it's a bit short on examples and
     a user guide would be nice."  Documentation is the sort of thing that
     will never be great unless someone from outside contributes it (since
     (https://lwn.net/Articles/380983/), "it's a bit short on examples and
     a user guide would be nice."  Documentation is the sort of thing that
     will never be great unless someone from outside contributes it (since