summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorAntoine Beaupré <anarcat@koumbit.org>2015-10-12 23:27:59 -0400
committerAntoine Beaupré <anarcat@koumbit.org>2015-10-12 23:27:59 -0400
commite59045fd242ece0ed09759f577121917cf6303c6 (patch)
tree2e95054e8a4427860c75209f410b85b10ff63608 /README.rst
parent3c535b9d7ab1f49e39c5b5632f97545b147b4b05 (diff)
move links from the sidebar to the readme
it seems sidebar links are not supported by the RTD theme just yet: https://github.com/snide/sphinx_rtd_theme/issues/254
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst30
1 files changed, 22 insertions, 8 deletions
diff --git a/README.rst b/README.rst
index a43375491..7d550e640 100644
--- a/README.rst
+++ b/README.rst
@@ -105,12 +105,30 @@ Now doing another backup, just to show off the great deduplication::
For a graphical frontend refer to our complementary project
`BorgWeb <https://github.com/borgbackup/borgweb>`_.
+Links
+-----
+
+ * `Main Web Site <https://borgbackup.readthedocs.org/>`_
+ * `Releases <https://github.com/borgbackup/borg/releases>`_
+ * `PyPI packages <https://pypi.python.org/pypi/borgbackup>`_
+ * `ChangeLog <https://github.com/borgbackup/borg/blob/master/CHANGES.rst>`_
+ * `GitHub <https://github.com/borgbackup/borg>`_
+ * `Issue Tracker <https://github.com/borgbackup/borg/issues>`_
+ * `Bounties & Fundraisers <https://www.bountysource.com/teams/borgbackup>`_
+ * `Mailing List <http://librelist.com/browser/borgbackup/>`_
+ * `License <https://borgbackup.github.io/borgbackup/authors.html#license>`_
+
+Related Projects
+----------------
+
+ * `BorgWeb <https://borgbackup.github.io/borgweb/>`_
+ * `Atticmatic <https://github.com/witten/atticmatic/>`_
+ * `Attic <https://github.com/jborg/attic>`_
Notes
-----
-Borg is a fork of `Attic <https://github.com/jborg/attic>`_ and maintained by
-"`The Borg collective`_".
+Borg is a fork of `Attic`_ and maintained by "`The Borg collective`_".
.. _The Borg collective: http://borgbackup.github.io/borgbackup/authors.html
@@ -120,20 +138,16 @@ 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 the
-`changelog`_ (or ``CHANGES.rst`` in the source distribution) for more
+`ChangeLog`_ (or ``CHANGES.rst`` in the source distribution) for more
information.
-.. _changelog: https://borgbackup.github.io/borgbackup/changes.html
-
NOT RELEASED DEVELOPMENT VERSIONS HAVE UNKNOWN COMPATIBILITY PROPERTIES.
THIS IS SOFTWARE IN DEVELOPMENT, DECIDE YOURSELF WHETHER IT FITS YOUR NEEDS.
-Borg is distributed under a 3-clause BSD license, see `the license`_
+Borg is distributed under a 3-clause BSD license, see `License`_
for the complete license.
-.. _the license: https://borgbackup.github.io/borgbackup/authors.html#license
-
|build| |coverage|
.. |build| image:: https://travis-ci.org/borgbackup/borg.svg