From 54880651beb79b3d32aa7945ca3481bba0cf0def Mon Sep 17 00:00:00 2001 From: Fuxino Date: Thu, 8 Oct 2026 18:19:35 +0200 Subject: [PATCH] Fix outdated and wrong information in README Use git.shouldnt.work as the clone URL, don't install wheel for building, as setuptools no longer needs it, list paramiko among the optional dependencies, and use the correct names of the remote backup options (--ssh-user, --ssh-host). --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5038b44..30f62e9 100644 --- a/README.md +++ b/README.md @@ -20,19 +20,19 @@ The script uses rsync to actually run the backup, so you will have to install it sudo pacman -Syu rsync ``` -Optional dependencies are systemd-python to enable using systemd journal for logging, and dbus-python for desktop notifications. +Optional dependencies are systemd-python to enable using systemd journal for logging, dbus-python for desktop notifications, and paramiko for remote backup. ## Install To install the program, first clone the repository: ```bash -git clone https://github.com/Fuxino/simple_backup.git +git clone https://git.shouldnt.work/fuxino/simple_backup.git ``` Then install the tools required to build the package: ```bash -pip install --upgrade build wheel +pip install --upgrade build ``` Finally, run: @@ -56,7 +56,7 @@ The only rsync error that is ignored is return code 24 (source files vanished du > **Warning** > This feature is experimental -It's possible to use a remote server as destination for the backup. Just use the --username (or -u) and --host arguments (or set them in the configuration file). +It's possible to use a remote server as destination for the backup. Just use the --ssh-user and --ssh-host arguments (or set them in the configuration file). For this to work, rsync must be installed on the server too. ### Server authentication