deduplicate and refactor the docs

README.rst (shown on github and also at the start of the html docs) shall
be like an elevator speech - convince readers in a very short time.
this is most important, everything else can come after we got the reader's interest.

include README into docs to avoid duplication.
also include CHANGES into docs.
add developer docs, move examples from tox.ini there
add separate support docs
remove glossary, most of what was there can be understood by an admin from context
move attic and compatibility note to the end

1 files changed, 77 insertions, 51 deletions

diff --git a/README.rst b/README.rst
index c9cf90706..1e1920410 100644
--- a/README.rst
+++ b/README.rst
@@ -1,52 +1,31 @@
-|build|
-
 What is Borg?
 -------------
-Borg is a deduplicating backup program. The main goal of Borg is to provide
-an efficient and secure way to backup data. The data deduplication
-technique used makes Borg suitable for daily backups since only changes
-are stored.
-
-Borg is a fork of `Attic <https://github.com/jborg/attic>`_ and maintained by "`The Borg Collective <https://github.com/borgbackup/borg/blob/master/AUTHORS>`_".
-
-BORG IS NOT COMPATIBLE WITH ORIGINAL ATTIC.
-EXPECT THAT WE WILL BREAK COMPATIBILITY REPEATEDLY WHEN MAJOR RELEASE NUMBER
-CHANGES (like when going from 0.x.y to 1.0.0). Please read CHANGES document.
-
-NOT RELEASED DEVELOPMENT VERSIONS HAVE UNKNOWN COMPATIBILITY PROPERTIES.
-
-THIS IS SOFTWARE IN DEVELOPMENT, DECIDE YOURSELF WHETHER IT FITS YOUR NEEDS.
+Borg is a deduplicating backup program.
+Optionally, it also supports compression and authenticated encryption.
 
-Read `issue #1 <https://github.com/borgbackup/borg/issues/1>`_ on the issue tracker, goals are being defined there.
-
-Please also see the `LICENSE  <https://github.com/borgbackup/borg/blob/master/LICENSE>`_ for more informations.
-
-Easy to use
-~~~~~~~~~~~
-Initialize backup repository and create a backup archive::
-
-    $ borg init /mnt/backup
-    $ borg create -v /mnt/backup::documents ~/Documents
-
-For a graphical frontend refer to our complementary project `BorgWeb <https://github.com/borgbackup/borgweb>`_.
+The main goal of Borg is to provide an efficient and secure way to backup data.
+The data deduplication technique used makes Borg suitable for daily backups
+since only changes are stored.
+The authenticated encryption technique makes it suitable for backups to not
+fully trusted targets.
 
 Main features
 ~~~~~~~~~~~~~
 Space efficient storage
-  Variable block size deduplication is used to reduce the number of bytes 
+  Variable block size deduplication is used to reduce the number of bytes
   stored by detecting redundant data. Each file is split into a number of
   variable length chunks and only chunks that have never been seen before are
-  compressed and added to the repository.
+  added to the repository.
 
   The content-defined chunking based deduplication is applied to remove
-  duplicate chunks within: 
+  duplicate chunks within:
 
   * the current backup data set (even inside single files / streams)
   * current and previous backups of same machine
   * all the chunks in the same repository, even if coming from other machines
 
   This advanced deduplication method does NOT depend on:
- 
+
   * file/directory names staying the same (so you can move your stuff around
     without killing the deduplication, even between machines sharing a repo)
   * complete files or time stamps staying the same (if a big file changes a
@@ -59,37 +38,84 @@ Optional data encryption
     All data can be protected using 256-bit AES encryption and data integrity
     and authenticity is verified using HMAC-SHA256.
 
+Optional compression
+    All data can be compressed (by zlib, level 0-9).
+
 Off-site backups
     Borg can store data on any remote host accessible over SSH.  This is
-    most efficient if Borg is also installed on the remote host.
+    most efficient if Borg is also installed on the remote host. If you can't
+    install Borg there, you can also use some network filesystem (sshfs, nfs,
+    ...), but it will be less efficient.
 
 Backups mountable as filesystems
     Backup archives are mountable as userspace filesystems for easy backup
     verification and restores.
 
-What do I need?
----------------
-Borg requires Python 3.2 or above to work.
-Borg also requires a sufficiently recent OpenSSL (>= 1.0.0).
-In order to mount archives as filesystems, llfuse is required.
+Platforms Borg works on
+  * Linux
+  * FreeBSD
+  * Mac OS X
+  * Cygwin (unsupported)
+
+
+Easy to use
+~~~~~~~~~~~
+Initialize a new backup repository and create a backup archive::
+
+    $ borg init /mnt/backup
+    $ borg create /mnt/backup::Monday ~/Documents
+
+Now doing another backup, just to show off the great deduplication::
+
+    $ borg create --stats /mnt/backup::Tuesday ~/Documents
+
+    Archive name: Tuesday
+    Archive fingerprint: 387a5e3f9b0e792e91ce87134b0f4bfe17677d9248cb5337f3fbf3a8e157942a
+    Start time: Tue Mar 25 12:00:10 2014
+    End time:   Tue Mar 25 12:00:10 2014
+    Duration: 0.08 seconds
+    Number of files: 358
+                           Original size      Compressed size    Deduplicated size
+    This archive:               57.16 MB             46.78 MB            151.67 kB
+    All archives:              114.02 MB             93.46 MB             44.81 MB
+
+For a graphical frontend refer to our complementary project
+`BorgWeb <https://github.com/borgbackup/borgweb>`_.
+
+
+How to proceed from here
+------------------------
+Everything about requirements, installation, getting a quick start, usage
+reference, FAQ, support info, internals and developer infos is in our
+documentation:
+
+See `our online documentation <https://borgbackup.github.io/>`_
+or alternatively read it in raw text form in the `docs/*.rst` files.
 
-How do I install it?
---------------------
-::
 
-  $ pip3 install borgbackup
+Notes
+-----
+
+Build status:
+|build|
+
+Borg is a fork of `Attic <https://github.com/jborg/attic>`_ and maintained by
+"`The Borg Collective <https://github.com/borgbackup/borg/blob/master/AUTHORS>`_".
+
+BORG IS NOT COMPATIBLE WITH ORIGINAL ATTIC.
+EXPECT THAT WE WILL BREAK COMPATIBILITY REPEATEDLY WHEN MAJOR RELEASE NUMBER
+CHANGES (like when going from 0.x.y to 1.0.0). Please read CHANGES document.
+
+NOT RELEASED DEVELOPMENT VERSIONS HAVE UNKNOWN COMPATIBILITY PROPERTIES.
+
+THIS IS SOFTWARE IN DEVELOPMENT, DECIDE YOURSELF WHETHER IT FITS YOUR NEEDS.
 
-Where are the docs?
--------------------
-Go to https://borgbackup.github.io/ for a prebuilt version of the documentation.
-You can also build it yourself from the docs folder.
+Read `issue #1 <https://github.com/borgbackup/borg/issues/1>`_ on the issue
+tracker, goals are being defined there.
 
-Where are the tests?
---------------------
-The tests are in the borg/testsuite package. To run the test suite use the
-following command::
+For more information, please also see the
+`LICENSE  <https://github.com/borgbackup/borg/blob/master/LICENSE>`_.
 
-  $ fakeroot -u tox  # you need to have tox and pytest installed
 
 .. |build| image:: https://travis-ci.org/borgbackup/borg.svg
         :alt: Build Status