Nebucatnetzer
/
borg_interface
Archived
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

extend the readme

This commit is contained in:
Andreas Zweili 2016-12-14 16:28:06 +01:00
parent 2d449a0916
commit bd72ca51eb
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -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.