diff -r 26080284df3c -r 84b041f6f7f3 README.md --- a/README.md Sun Dec 05 14:58:56 2021 +0200 +++ b/README.md Sun Dec 05 15:08:50 2021 +0200 @@ -27,33 +27,23 @@ ## Installation -Borgend naturally requires [Borg Backup][] to be installed. Borgend is written -in [Python](https://www.python.org/), and also requires a working python3 installation. -Install both according to the instructions for your operating system. Borgend also -requires some additional Python libraries. To install these, on macOS, run +Borgend naturally requires [Borg Backup][] to be installed as well as a working +[Python 3](https://www.python.org/) installation. Install both according to the +instructions for your operating system. With this done, located in the top-level +directory of the borgend source tree, you can install borgend - pip3 install keyring pyyaml rumps - -On other systems, run - - pip3 install keyring pyyaml xdg - -This will install the following Python packages: + pip3 install . - - [keyring](https://pypi.python.org/pypi/keyring) to extract passphrases - from the keychain - - [pyyaml](http://pyyaml.org/) for parsing configuration files - - [rumps](https://github.com/jaredks/rumps) (Ridiculously Uncomplicated - macOS Python Statusbar apps) - - [xdg](https://pypi.python.org/pypi/xdg/3.0.0) for configuration file - location (not needed on macOS) +This will also install some additional Python libraries +([keyring](https://pypi.python.org/pypi/keyring), +[pyyaml](http://pyyaml.org/), +[rumps](https://github.com/jaredks/rumps), and, if not on MacOS, +[xdg](https://pypi.python.org/pypi/xdg/3.0.0)). +Now you can start borgend with -With the dependencies satisfied, and Borgend downloaded, it may be run from -its download location with + borgend - python3 borgend - -Before this, you will probably, however, want to create a configuration file as detailed below. +Before this, you will probably, however, want to create a configuration file as detailed below. A standalone application, explained below, can be more convenient for access to passwords from the system keyring. ## Usage and configuration