Projects/grzegorz
Projects
/
grzegorz
7
1
Fork 0
Code Issues Pull Requests 1 Wiki Activity

Prettify and clarify the README

This commit is contained in:
Peder Bergebakken Sundt 2018-03-06 17:18:17 +01:00
parent a9129b197a
commit 1fc1ab2e1d
1 changed files with 6 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -6,7 +6,7 @@ Why the name Grzegorz? [We have a bad taste in humor!](https://youtu.be/t-fcrn1E
When Grzegorz starts, it launches an instance of MPV and maintains it. It is designed to be used as an info screen or HTPC, and supports multiple users to push changes to the MPV instance. When Grzegorz starts, it launches an instance of MPV and maintains it. It is designed to be used as an info screen or HTPC, and supports multiple users to push changes to the MPV instance.
The API id described and can be tested on `http:/localhost:8080/swagger` when the server is running. All API endpoints are available under `/api` The API is described and can be tested at `http:/localhost:8080/swagger` while the server is running. All API endpoints are available under `/api`
## How to run it ## How to run it
@ -15,17 +15,13 @@ First of we need to install any needed dependencies. If you want to, you may do
To install the needed dependencies, run this with sufficient rights (as root?): To install the needed dependencies, run this with sufficient rights (as root?):
```
pip install -r requirements.txt pip install -r requirements.txt
```
Gregorz manages a MPV process, meaning you need MPV installed on your system. Look for it in your package manager. Gregorz manages a MPV process, meaning you need MPV installed on your system. Look for it in your package manager.
When finished, you may run the server with: When finished, you may run the server with:
```
python3 main.py python3 main.py
```
The server should now be available at `http://localhost:8080/`. The server should now be available at `http://localhost:8080/`.
You may change the address and port in the file named `config.py` You may change the address and port in the file named `config.py`
@ -36,9 +32,7 @@ You may change the address and port in the file named `config.py`
When setting up a info screen or HTPC using Grzegors, you may configure it to run automatically on startup. When setting up a info screen or HTPC using Grzegors, you may configure it to run automatically on startup.
We recommend installing a headless linux, and create a user for Grzegorz to run as. (We named ours `grzegorz`, obviously) We recommend installing a headless linux, and create a user for Grzegorz to run as. (We named ours `grzegorz`, obviously)
Then make systemd automatically spin up a X session to run Grzegorz in: Copy the files in the folder `dist` into `$HOME/.config/systemd/user` and run the following commands as your user: Clone this repo into the home directory. Then make systemd automatically spin up a X session to run Grzegorz in: Copy the files in the folder `dist` into the folder `$HOME/.config/systemd/user` and run the following commands as your user:
```
$ systemd --user enable grzegorz@0.service $ systemd --user enable grzegorz@0.service
$ systemd --user start grzegorz@0.service $ systemd --user start grzegorz@0.service
```