Browse Source

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
Antoine Beaupré 9 years ago
parent
commit
6629772760
1 changed files with 4 additions and 2 deletions
  1. 4 2
      README.rst

+ 4 - 2
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.