bup-ls(1): document support for --remote host:port

[bup.git] / README.md

diff --git a/README.md b/README.md
index f7455a63e186876d1c5a74ab9787ded79620299d..82b0cba3e8e70d9ebd2724e9b3fb0d4550833bc3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -86,6 +86,8 @@ Reasons you might want to avoid bup
 Notable changes introduced by a release
 =======================================
 
+ - <a href="note/0.29.3-from-0.29.2.md">Changes in 0.29.3 as compared to 0.29.2</a>
+ - <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>
@@ -93,6 +95,14 @@ Notable changes introduced by a release
  - <a href="note/0.27.1-from-0.27.md">Changes in 0.27.1 as compared to 0.27</a>
 
 
+Test status
+===========
+
+| branch | Debian                                                                                                                                         | FreeBSD                                                                                                                                          | macOS                                                                                                                                        |
+|--------|------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|
+| master | [![Debian test status](https://api.cirrus-ci.com/github/bup/bup.svg?branch=master&task=debian)](https://cirrus-ci.com/github/bup/bup) | [![FreeBSD test status](https://api.cirrus-ci.com/github/bup/bup.svg?branch=master&task=freebsd)](https://cirrus-ci.com/github/bup/bup) | [![macOS test status](https://api.cirrus-ci.com/github/bup/bup.svg?branch=master&task=macos)](https://cirrus-ci.com/github/bup/bup) |
+| 0.29.x | [![Debian test status](https://api.cirrus-ci.com/github/bup/bup.svg?branch=0.29.x&task=debian)](https://cirrus-ci.com/github/bup/bup) | [![FreeBSD test status](https://api.cirrus-ci.com/github/bup/bup.svg?branch=0.29.x&task=freebsd)](https://cirrus-ci.com/github/bup/bup) | [![macOS test status](https://api.cirrus-ci.com/github/bup/bup.svg?branch=0.29.x&task=macos)](https://cirrus-ci.com/github/bup/bup) |
+
 Getting started
 ===============
 
@@ -153,7 +163,11 @@ From source
        
  - 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
@@ -209,7 +223,9 @@ Using bup
         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
 
@@ -296,7 +312,7 @@ Using bup
  - 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"):