comparison: README.md
README.md
- changeset 139
- 84b041f6f7f3
- parent 134
- a7aa8ca7b3d0
- child 140
- a70ba964f455
equal
deleted
inserted
replaced
| 138:26080284df3c | 139:84b041f6f7f3 |
|---|---|
| 25 | 25 |
| 26 [Borg Backup]: https://www.borgbackup.org/ | 26 [Borg Backup]: https://www.borgbackup.org/ |
| 27 | 27 |
| 28 ## Installation | 28 ## Installation |
| 29 | 29 |
| 30 Borgend naturally requires [Borg Backup][] to be installed. Borgend is written | 30 Borgend naturally requires [Borg Backup][] to be installed as well as a working |
| 31 in [Python](https://www.python.org/), and also requires a working python3 installation. | 31 [Python 3](https://www.python.org/) installation. Install both according to the |
| 32 Install both according to the instructions for your operating system. Borgend also | 32 instructions for your operating system. With this done, located in the top-level |
| 33 requires some additional Python libraries. To install these, on macOS, run | 33 directory of the borgend source tree, you can install borgend |
| 34 | 34 |
| 35 pip3 install keyring pyyaml rumps | 35 pip3 install . |
| 36 | 36 |
| 37 On other systems, run | 37 This will also install some additional Python libraries |
| 38 ([keyring](https://pypi.python.org/pypi/keyring), | |
| 39 [pyyaml](http://pyyaml.org/), | |
| 40 [rumps](https://github.com/jaredks/rumps), and, if not on MacOS, | |
| 41 [xdg](https://pypi.python.org/pypi/xdg/3.0.0)). | |
| 42 Now you can start borgend with | |
| 38 | 43 |
| 39 pip3 install keyring pyyaml xdg | 44 borgend |
| 40 | 45 |
| 41 This will install the following Python packages: | 46 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. |
| 42 | |
| 43 - [keyring](https://pypi.python.org/pypi/keyring) to extract passphrases | |
| 44 from the keychain | |
| 45 - [pyyaml](http://pyyaml.org/) for parsing configuration files | |
| 46 - [rumps](https://github.com/jaredks/rumps) (Ridiculously Uncomplicated | |
| 47 macOS Python Statusbar apps) | |
| 48 - [xdg](https://pypi.python.org/pypi/xdg/3.0.0) for configuration file | |
| 49 location (not needed on macOS) | |
| 50 | |
| 51 With the dependencies satisfied, and Borgend downloaded, it may be run from | |
| 52 its download location with | |
| 53 | |
| 54 python3 borgend | |
| 55 | |
| 56 Before this, you will probably, however, want to create a configuration file as detailed below. | |
| 57 | 47 |
| 58 ## Usage and configuration | 48 ## Usage and configuration |
| 59 | 49 |
| 60 ### Configuration file | 50 ### Configuration file |
| 61 | 51 |
