summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
index 06be63c..e529901 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,24 @@
This is a convenience wrapper around the Borg backup tool.
+## Expected Environment
+
+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.
+
+
+## Installation
+
+For Arch Linux:
+
+```
+git clone https://src.xengineering.eu/xengineering/xbackup.git
+cd xbackup/archlinux
+make install
+```
+
+This will create the Arch Linux package for xbackup and installs it as a foreign / unofficial package (like the AUR packages).
+
+
## Done / Features
(Last finished task first)
@@ -20,7 +38,9 @@ This is a convenience wrapper around the Borg backup tool.
(Highest priority first)
- [ ] manual backup functionality / MVP
+- [ ] software list file support (generates list of all linux packages)
- [ ] XMPP notification via [xbot](https://gitea.xengineering.eu/xengineering/xbot)
+- [ ] MariaDB fullbackup
- [ ] backup systemd daemon
- [ ] backup transfer tool (?)
- [ ] backup diff tool (backup vs. filesystem)