diff -r 3e9d88b2c14b -r 9f3ae6b3133f README.md --- a/README.md Mon Apr 20 18:14:12 2020 -0500 +++ b/README.md Tue Apr 21 09:59:51 2020 -0500 @@ -25,7 +25,10 @@ ## Installation -On macOS, first run +Borgend is written in [Python](https://www.python.org/), and requires a working +python3 installation. Install it according to instructions for your operating +system. Borgend also requires some additional Python libraries. To install these, +on macOS, run pip3 install keyring pyyaml rumps @@ -43,29 +46,12 @@ - [xdg](https://pypi.python.org/pypi/xdg/3.0.0) for configuration file location (not needed on macOS) -With the dependencies satisfied, Borgend may be run with +With the dependencies satisfied, and Borgend downloaded, it may be run from +its download location with python3 borgend.py -To permanently authenticate Borgend to use the keychain, and therefore not -have to enter the keychain password every time Borgend is launched, it is -useful to create a standalone Mac app. This can be done with - - - [py2app](https://py2app.readthedocs.io/en/latest/install.html). - -To create an app that you can launch at startup and give permanent permissions -to the keychain, use - - python3 setup.py py2app -A - -The app hould be placed under `dist/`. Copy it to your `Applications` -directory, and set it up to launch on login. - -If you are keen on wasting your life, you can try to run py2app without the -`-A` option to create a standalone app that you can copy to computers without -Python installed, but it will probably most likely not work because py2app -is shit. Currently (2018-09-18) it is not working with the keyring package. - +Before this, you will probably, however, want to create a configuration file as detailed below. ## Usage and configuration @@ -93,3 +79,21 @@ security add-generic-password -a myrepo -s borg-backup -w [PASSWORD] +To permanently authenticate Borgend to use the keychain, and therefore not +have to enter the keychain password every time Borgend is launched, it is +useful to encapculate it into a macOS app. This can be done with + + - [py2app](https://py2app.readthedocs.io/en/latest/install.html). + +To create an app that you can launch at startup and give permanent permissions +to the keychain, use + + python3 setup.py py2app -A + +The app hould be placed under `dist/`. Copy it to your `Applications` +directory, and set it up to launch on login. + +If you are keen on wasting your life, you can try to run py2app without the +`-A` option to create a standalone app that you can copy to computers without +Python installed. This will, however, most likely not work because py2app +is shit. Currently (2018-09-18) it is not working with the keyring package.