From 6629772760fe62d88cf500e857775e6aa91ed334 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Antoine=20Beaupr=C3=A9?= Date: Wed, 7 Oct 2015 17:36:34 -0400 Subject: [PATCH] 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 --- README.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 310413bf..1fd07c2d 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 `_ +See the `installation manual `_ 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.