X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=README.md;h=6ace0a480c31c8c686f38dd35884ac76cf05c56d;hb=90ad13beb17df15ed93fbd5eea7e2a0343d390f3;hp=e5d0f7315392d02b8e8545885fa39be3e8e24af2;hpb=e55fed0f6a965a1c625f5282e164f82bb888c78b;p=bup.git
diff --git a/README.md b/README.md
index e5d0f73..6ace0a4 100644
--- a/README.md
+++ b/README.md
@@ -67,18 +67,18 @@ bup has a few advantages over other backup software:
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
- 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.
- It currently only works on Linux, FreeBSD, NetBSD, OS X >= 10.4,
- Solaris, or Windows (with Cygwin). Patches to support other
- platforms are welcome.
+ Solaris, or Windows (with Cygwin, and maybe with WSL). Patches to
+ support other platforms are welcome.
- Any items in "Things that are stupid" below.
@@ -86,6 +86,7 @@ Reasons you might want to avoid bup
Notable changes introduced by a release
=======================================
+ - Changes in 0.29.2 as compared to 0.29.1
- Changes in 0.29.1 as compared to 0.29
- Changes in 0.29 as compared to 0.28.1
- Changes in 0.28.1 as compared to 0.28
@@ -93,6 +94,13 @@ Notable changes introduced by a release
- Changes in 0.27.1 as compared to 0.27
+Test status: [](https://cirrus-ci.com/github/bup/bup)
+[](https://cirrus-ci.com/github/bup/bup)
+[](https://cirrus-ci.com/github/bup/bup)
+==============================================================
+
+
+
Getting started
===============
@@ -103,6 +111,15 @@ From source
git clone https://github.com/bup/bup
+ - This will leave you on the master branch, which is perfect if you
+ would like to help with development, but if you'd just like to use
+ bup, please check out the latest stable release like this:
+
+ git checkout 0.29.1
+
+ You can see the latest stable release here:
+ https://github.com/bup/bup/releases.
+
- Install the required python libraries (including the development
libraries).
@@ -144,7 +161,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
@@ -200,7 +221,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
@@ -287,7 +310,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"):
@@ -508,7 +531,7 @@ mailing list (see below) if you'd like to help.
- 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