diff options
| author | Antoine Beaupré <anarcat@koumbit.org> | 2015-10-07 17:36:34 -0400 |
|---|---|---|
| committer | Antoine Beaupré <anarcat@koumbit.org> | 2015-10-07 17:54:43 -0400 |
| commit | 6629772760fe62d88cf500e857775e6aa91ed334 (patch) | |
| tree | 4ccfd6be9430d0d020e24ca7716b2c37ddb144ef /README.rst | |
| parent | df20e512a002c1ac7d36b57929155b222671fc93 (diff) | |
make readme a little more readable
link to source documents for people that are reading just the README without a web browser
hyperlink to the changes document as well
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/README.rst b/README.rst index 310413bfe..1fd07c2d9 100644 --- a/README.rst +++ b/README.rst @@ -9,7 +9,8 @@ since only changes are stored. The authenticated encryption technique makes it suitable for backups to not fully trusted targets. -`Borg Installation docs <http://borgbackup.github.io/borgbackup/installation.html>`_ +See the `installation manual <installation>`_ or, if you have already +downloaded Borg, ``docs/installation.rst`` to get started with Borg. Main features @@ -115,7 +116,8 @@ considerations regarding project goals and policy of the Borg project. 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. +CHANGES (like when going from 0.x.y to 1.0.0). Please read the +`changelog`_ (or ``CHANGES.rst`` in the source distribution) for more information. NOT RELEASED DEVELOPMENT VERSIONS HAVE UNKNOWN COMPATIBILITY PROPERTIES. |