From b65901c1513c845e3e85b57843969a9fe97330ff Mon Sep 17 00:00:00 2001 From: "L. Bradley LaBoon" Date: Fri, 29 Jun 2018 22:29:09 -0400 Subject: [PATCH] Converted the README to markdown --- README => README.md | 35 ++++++++++++++++------------------- 1 file changed, 16 insertions(+), 19 deletions(-) rename README => README.md (54%) diff --git a/README b/README.md similarity index 54% rename from README rename to README.md index 40bbbfc..3e0f4d0 100644 --- a/README +++ b/README.md @@ -1,5 +1,8 @@ -About backly -============ +# backly + +A simple directory cloner + +## About backly backly is a simple rsync-like tool for recursively copying entire directories. The intended use case is for making verionless incremental backups; however, it @@ -8,31 +11,25 @@ provided you have read access to the source and write access to the destination. Like rsync, backly uses a combination of file size and modification date to determine if it needs to be copied over. -This program will not work properly if source is a subdirectory +This program will **not** work properly if source is a subdirectory or destination or vice-versa. - -Required packages -================= +## Required packages backly does not depend on any packages other than what typically ships with any Linux distribution. +## Installation -Installation -============ +The usual `make` and `make install` is sufficient for compiling and installing +backly. The default prefix is `/usr/local`, which means the binary will be +installed to `/usr/local/bin`. The prefix can be changed by setting it in the +install command; for example, by running `make PREFIX=/usr install`. -The usual 'make' and 'make install' is sufficient for compiling and installing -backly. The default prefix /usr/local, which means the binary will be installed -to /usr/local/bin. The prefix can be changed by setting it in the install -command; for example, by running 'make PREFIX=/usr install'. +## How to report bugs? - -How to report bugs? -=================== - -Bugs should be reported to L. Bradley LaBoon +Open an issue on the issue tracker. Please indicate what OS and architecture you are using, as well as output from -the program showing the bug, if possible (hint: run backly with --test to avoid -destroying any files that you care about). +the program showing the bug, if possible (hint: run backly with `--test` to +avoid destroying any files that you care about).