extend the readme
This commit is contained in:
parent
2d449a0916
commit
bd72ca51eb
15
README.md
15
README.md
|
@ -3,11 +3,22 @@
|
||||||
This application provides an interface to borg backup. At a later point it might
|
This application provides an interface to borg backup. At a later point it might
|
||||||
as well work with restic.
|
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.
|
To start the application simply execute the borg_interface file.
|
||||||
You will then see a list of options which are fairly self explanatory.
|
You will then see a list of options which are fairly self explanatory.
|
||||||
|
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
To configure borg_interface please edit the borg_interface.cfg file.
|
To configure borg_interface please edit the borg_interface.cfg file.
|
||||||
All the options have to be placed under the [DEFAULT] section.
|
All the options have to be placed under the [DEFAULT] section.
|
||||||
|
|
Reference in New Issue