fleg
/
menu
mirror of https://git.sr.ht/~michalr/menu
1
0
Fork 0
Code

Added some simple documentation into README

This commit is contained in:
Michał Rudowicz 2024-09-10 16:25:48 +02:00
parent 8c64d82fa9
commit abbaec38da
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -3,3 +3,19 @@
Simple GUI menu aimed at touchscreens that is supposed to provide quick actions for the user.
[![builds.sr.ht status](https://builds.sr.ht/~michalr/menu.svg)](https://builds.sr.ht/~michalr/menu?)
## Configuration
Configuration is done using a JSON file. See [`example_config.json`](./example_config.json) for details.
## Available actions
### `MSG`
Shows a message `action_message` for `action_param` number of seconds.
`action_param` must be an integer.
## `GET`
Performs a `GET` on the `action_param` URL while displaying `action_message`.