diff --git a/.envrc b/.envrc new file mode 100644 index 0000000..2ca12fb --- /dev/null +++ b/.envrc @@ -0,0 +1,8 @@ +#!/usr/bin/env bash +# This file is loaded with `direnv`. +# It enters you into the poetry venv, removing the need for `poetry run`. + +poetry run true # create venv if it doesn't exist +export VIRTUAL_ENV=$(poetry env info --path) +export POETRY_ACTIVE=1 +PATH_add "$VIRTUAL_ENV/bin" diff --git a/README.md b/README.md index 30551a8..04c7f4b 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # Grzegorz API -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) +`grzegorz` is simple REST API for managing an instance of MPV. +Why "Grzegorz"? [Great taste in humor of course!](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 info screen or HTPC, and supports multiple users to push changes to the MPV instance. 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` @@ -33,12 +33,14 @@ The server should now be available at `http://localhost:8000/`. Grzegors will make a unix socket in the current working directory. Make sure it is somewhere writeable! -## Making Grzegorz run on boot +## Making `grzegorz` run on boot + + 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) -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: +We recommend installing a headless linux, and create a user for `grzegorz` to run as. (We named ours `grzegorz`, obviously) +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: $ systemctl --user enable grzegorz@0.service $ systemctl --user start grzegorz@0.service