From bd72ca51eb6022e26218119039077b319e18667e Mon Sep 17 00:00:00 2001 From: Andreas Zweili Date: Wed, 14 Dec 2016 16:28:06 +0100 Subject: [PATCH] extend the readme --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f108d9a..ce82b43 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,22 @@ This application provides an interface to borg backup. At a later point it might as well work with restic. -### Installation and Getting started +### Installation +To install the application either "git clone" it in the folder you want with: + +``` +git clone https://git.2li.ch/Nebucatnetzer/borg_interface.git +``` + +or simply download it and extract the zip to your prefered location.: +* https://git.2li.ch/Nebucatnetzer/borg_interface/archive/master.zip + +### Starting +Before starting the application make sure that you have configured it properly. +See the section [Configuration](https://git.2li.ch/Nebucatnetzer/borg_interface#configuration) for more details. To start the application simply execute the borg_interface file. You will then see a list of options which are fairly self explanatory. - ### Configuration To configure borg_interface please edit the borg_interface.cfg file. All the options have to be placed under the [DEFAULT] section.