From f1a841204f10a03882e8ce281c27aa8ee95f5c93 Mon Sep 17 00:00:00 2001 From: Derisis13 Date: Fri, 10 Dec 2021 20:03:01 +0100 Subject: [PATCH] README with instructions for usage, installation and --- README | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README b/README index 1024dc5..812921e 100644 --- a/README +++ b/README @@ -6,13 +6,18 @@ backup_assistant [opts] Options: `-h --help`: show help and exit `-d --backup-dir [directory]`: set the directory for the backup/restoration (default is ~/.backups) - `-r --restore`: run the restoration (from backupdir). You must be root to restore, as you'll install packages + `-r --restore`: run the restoration (from backupdir). You must be root to restore, as you'll install packages. If you are backing up from a directory different from `~/.backup` you need to use the -d/--backup-dir option BEFORE the -r/--restore + +# Installation + +After downloading run: `python3 setup.py install` # Using with cron In a terminal run: `crontab` (you might need to choose an editor to continue) Once you see your crontab in your editor paste the following line at the end: -`` +`0 * * * * barusu` +This will attempt to run barusu hourly, however it'll only fully run once daily and exit every other time to save system resources. # How it works: @@ -25,4 +30,4 @@ restore: (you must call the script as root when restoring!) 1. It uses `dpkg` to set a list of operations exported in `~/.backup/packagelist.txt` then calls `apt-get` to install them 2. It uses `dconf` to load settings exported in `~/.backup/dconf_out.txt` -It is possible to provide an alternative backup folder using option `-d` or `backup-dir` as with backups +It is possible to provide an alternative backup folder using option `-d` or `backup-dir` as with backups, but you need to specify the folder BEFORE the -r/--restore option