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).
This commit is contained in:
Fuxino
2026-10-08 18:19:35 +02:00
parent 793a30fad8
commit 54880651be
+4 -4
View File
@@ -20,19 +20,19 @@ The script uses rsync to actually run the backup, so you will have to install it
sudo pacman -Syu rsync 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 ## Install
To install the program, first clone the repository: To install the program, first clone the repository:
```bash ```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: Then install the tools required to build the package:
```bash ```bash
pip install --upgrade build wheel pip install --upgrade build
``` ```
Finally, run: Finally, run:
@@ -56,7 +56,7 @@ The only rsync error that is ignored is return code 24 (source files vanished du
> **Warning** > **Warning**
> This feature is experimental > 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. For this to work, rsync must be installed on the server too.
### Server authentication ### Server authentication