Adjustements to the README.

[brioche.git] / README

diff --git a/README b/README
index 7e33dcdd4fa09f01a35f1e8b7456c1d8b0b5e986..5c17e901992f1324e3ca4429d1e97058ce93ef7b 100644 (file)
--- a/README
+++ b/README
@@ -1,3 +1,5 @@
+.. HTML version generated with rst2html -t README > README.html
+
 ==============
 Brioche Backup
 ==============
@@ -28,16 +30,17 @@ with incremental or differential backups, most of them rely on some filesystem
 capabilities, like *hard-linking*. If the only remote location available to
 store the backups is an FTP server, this is not a solution.
 Brioche relies on GNU tar's ``--listed-incremental`` option to create *real*
-differential[#diff]_ archives.
-
-.. [#diff] Each differential backup is based upon the last *full* backup, unlike
-           incremental, which are based upon the last (full or incremental)
-           backup.
+differential [#diff]_ archives.
 
 A second feature that makes Brioche interresting is the ability to use LVM
 snapshots. In the case of a Xen setup where the domUs use logical volumes as
 partitions, Brioche is able to backup everything from the dom0.
 
+
+.. [#diff] Each differential backup is based upon the last *full* backup, unlike
+      incremental, which are based upon the last (full or incremental) backup.
+
+
 Getting Brioche
 ===============
 
@@ -50,7 +53,7 @@ or get the latest development version with the following git command::
 Installation
 ============
 
-Copy the three files ``brioche``, `` brioche.conf`` and ``briochetab`` where
+Copy the three files ``brioche``, ``brioche.conf`` and ``briochetab`` where
 you like, and set the ``CONFIG_FILE`` variable in the ``brioche`` script
 accordingly. If needed, run ``chmod +x /path/to/brioche``.
 
@@ -190,11 +193,12 @@ author : Amand Tihon <amand.tihon@alrj.org>. Please include as much information
 as possible in your report.
 
 
+
 References
 ==========
 
-GNU tar documentation : http://www.gnu.org/software/tar/manual/
-LVM documentation and links : http://sourceware.org/lvm2/
+- GNU tar documentation : http://www.gnu.org/software/tar/manual/
+- LVM documentation and links : http://sourceware.org/lvm2/