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

Fix typos in README

This commit is contained in:
Peder Bergebakken Sundt 2018-03-05 23:11:55 +01:00
parent 1c7116fd75
commit 52245b1256
1 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -2,10 +2,9 @@
<img align="right" width="250" src="res/logo.png"> <img align="right" width="250" src="res/logo.png">
Grzegorz is simple REST API for managing an instance of MPV. Grzegorz is simple REST API for managing an instance of MPV.
Why the name Grzegorz? [We have a bad taste in humor!](https://youtu.be/t-fcrn1Edik)
Why the name Grzegorz? [We have a bad tast in humor!](https://youtu.be/t-fcrn1Edik) 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 infoscreen 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 id described and can be tested on `http:/localhost:8080/swagger` when the server is running. All API endpoints are available under `/api`
@ -20,7 +19,7 @@ To install the needed dependencies, run this with sufficient rights (as root?):
pip install -r requirements.txt pip install -r requirements.txt
``` ```
Gregorz managesa 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:
@ -34,7 +33,7 @@ You may change the address and port in the file named `config.py`
## Making Grzegorz run on boot ## Making Grzegorz run on boot
When setting up a infoscreen 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: 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: