From 2a69e15349d3cd2e4b5368828bc512a7bd47f4db Mon Sep 17 00:00:00 2001 From: Hugo Osvaldo Barrera Date: Mon, 28 Jun 2021 19:43:17 +0200 Subject: [PATCH] Add installation and usage instructions --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 7fe7b24..f792154 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,32 @@ Feel free to join the IRC channel: #pimutils on irc.libera.chat. our change detection. This is generally fine due to atomicity, but may result in pointless double-runs. +# Installation + +There's an [AUR package][aur] for ArchLinux users. + +For other platforms, you can build `autovdirsyncer` using: + + make + +And install using: + + sudo make install + +[aur]: https://aur.archlinux.org/packages/autovdirsyncer/ + +# Usage + +Finally, enable this to run as a service for your user with: + + systemctl --user enable --now autovdirsyncer + +`systemd` is not required, and you may use the service manager of your choice +to run this. + +Keep in mind that the binary is not in your `$PATH` my default, but in +`/usr/lib/autovdirsyncer`, since it's not intended to be run interactively. + # Licence autovdirsyncer is licensed under the ISC licence. See LICENCE for details. -- 2.45.2