From dff83dc7795bbd5a3fb1d88139ac7cd96a5bc655 Mon Sep 17 00:00:00 2001 From: xengineering Date: Thu, 7 Oct 2021 12:59:18 +0200 Subject: Update Documentation --- README.md | 29 +++++++++++++++++++++-------- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 3545d3d..e7554bd 100644 --- a/README.md +++ b/README.md @@ -10,25 +10,39 @@ This is a convenience wrapper around the Borg backup tool. This tool is designed for Arch Linux. Because it is written in Python and has minimal dependencies it should be easy to adapt it to other Linux distributions. +These dependencies have to be installed: + +- [python3](https://www.python.org/) +- [borg](https://www.borgbackup.org/) + ## Installation -For Arch Linux: +The Makefile of this repository contains an `install` target. Simply run ``` -git clone https://src.xengineering.eu/xengineering/xbackup.git -cd xbackup/archlinux -make install +sudo make install ``` -This will create the Arch Linux package for xbackup and installs it as a -foreign / unofficial package (like the AUR packages). +to install it to your system. Alternatively you can install it to a fake root +folder: + +``` +sudo make DESTDIR="path/to/my/fakeroot" install +``` + +or create only a tar archive from this source for external packaging: + +``` +make tarball +``` ## Done / Features (Last finished task first) +- [x] move Arch Linux packaging to pkgbuilds repository - [x] manual backup functionality / MVP - [x] config parsing - [x] argument parsing @@ -40,8 +54,7 @@ foreign / unofficial package (like the AUR packages). (Highest priority first) -- [ ] move Arch Linux packaging to pkgbuilds repository -- [ ] do qemu-based quality checks +- [ ] implement purge command - [ ] release v1.0.0 - [ ] XMPP notification via [xbot](https://gitea.xengineering.eu/xengineering/xbot) - [ ] MariaDB fullbackup -- cgit v1.2.3-70-g09d2