platypush/platypush
platypush
/
platypush
2
2
Fork 4
Code Issues 47 Pull Requests Packages Projects 4 Releases Wiki Activity

Updated README

This commit is contained in:
Fabio Manganiello 2021-09-17 00:05:06 +02:00
parent a2f5755496
commit 8c31905534
1 changed files with 4 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -389,16 +389,6 @@ cd $DIR_TO_PLATYPUSH
If you follow this route then simply run the commands listed in the plugin/backend documentation to get the dependencies If you follow this route then simply run the commands listed in the plugin/backend documentation to get the dependencies
installed. installed.
#### Check/uncomment the associated lines in [`requirements.txt`](https://git.platypush.tech/platypush/platypush/-/blob/master/requirements.txt).
If you follow this route then uncomment the lines in
[`requirements.txt`](https://git.platypush.tech/platypush/platypush/-/blob/master/requirements.txt) associated to the
plugins/backends that you want to use and run:
```shell
[sudo] pip3 install -r requirements.txt
```
After installing the dependencies, create a configuration file under `~/.config/platypush/config.yaml` (the application After installing the dependencies, create a configuration file under `~/.config/platypush/config.yaml` (the application
can load the configuration from another location through the `-c` option) containing the configuration of the backend can load the configuration from another location through the `-c` option) containing the configuration of the backend
and plugins that you want to use, and add any hooks and procedures for your use case. and plugins that you want to use, and add any hooks and procedures for your use case.
@ -479,6 +469,10 @@ platydock stop device_id
platydock rm device_id platydock rm device_id
``` ```
Note that both the virtual environment and Docker container option offer the possibility to include extra YAML configuration
files in the main `config.yaml` through the `include` directive (as long as they are in the same folder as the main
`config.yaml`), as well as external Python scripts in a `scripts` directory in the same folder as the `config.yaml`.
## Mobile app ## Mobile app
An [official Android app](https://f-droid.org/en/packages/tech.platypush.platypush/) is provided on the F-Droid store. An [official Android app](https://f-droid.org/en/packages/tech.platypush.platypush/) is provided on the F-Droid store.