comparison: README.md
README.md
- changeset 128
- 3e9d88b2c14b
- parent 126
- cf4e7b6f5f5e
- child 129
- 9f3ae6b3133f
equal
deleted
inserted
replaced
| 127:9badb0fb06eb | 128:3e9d88b2c14b |
|---|---|
| 23 | 23 |
| 24 The lead author is Tuomo Valkonen (<tuomov@iki.fi>). | 24 The lead author is Tuomo Valkonen (<tuomov@iki.fi>). |
| 25 | 25 |
| 26 ## Installation | 26 ## Installation |
| 27 | 27 |
| 28 You will need to install the following non-standard Python packages: | 28 On macOS, first run |
| 29 | |
| 30 pip3 install keyring pyyaml rumps | |
| 31 | |
| 32 On other systems, run | |
| 33 | |
| 34 pip3 install keyring pyyaml xdg | |
| 35 | |
| 36 This will install the following Python packages: | |
| 29 | 37 |
| 30 - [keyring](https://pypi.python.org/pypi/keyring) to extract passphrases | 38 - [keyring](https://pypi.python.org/pypi/keyring) to extract passphrases |
| 31 from the keychain | 39 from the keychain |
| 32 - [pyyaml](http://pyyaml.org/) for parse configuration files | 40 - [pyyaml](http://pyyaml.org/) for parse configuration files |
| 33 | |
| 34 The use the tray icon on macOS, you will need: | |
| 35 | |
| 36 - [rumps](https://github.com/jaredks/rumps) (Ridiculously Uncomplicated | 41 - [rumps](https://github.com/jaredks/rumps) (Ridiculously Uncomplicated |
| 37 macOS Python Statusbar apps) | 42 macOS Python Statusbar apps) |
| 38 | |
| 39 If you are not on macOS, you will need: | |
| 40 | |
| 41 - [xdg](https://pypi.python.org/pypi/xdg/3.0.0) for configuration file | 43 - [xdg](https://pypi.python.org/pypi/xdg/3.0.0) for configuration file |
| 42 location | 44 location (not needed on macOS) |
| 43 | 45 |
| 44 With the dependencies satisfied, Borgend may be run with | 46 With the dependencies satisfied, Borgend may be run with |
| 45 | 47 |
| 46 python3 borgend.py | 48 python3 borgend.py |
| 47 | 49 |
