diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index d6d8c69..c9ab4ee 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -83,8 +83,9 @@ make -f Makefile.dev release-arch - [x] 2nd window - [x] Use buffers as panels (INA A FXA / DEBUG A+B FXA+B / INB B FXB) - [x] Clean code and fix things - - [x] Share openGL state between monitor and screen + - [x] Share openGL state between monitor and screen - [ ] Other + - [ ] Use custom `#include xxx.glsl` preprocessor - [ ] Update readme with usage documentation - [x] Documentation in default config file - [x] Clone "shaders" and config in system path at setup diff --git a/README.md b/README.md index 3dc1551..55fcc53 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,9 @@ See [1H demo on YouTube](https://youtu.be/HgErrasSs-w) - [From release](#from-release) - [From repository (PKGBUILD)](#from-repository-pkgbuild) - [From repository (dev version)](#from-repository-dev-version) -- [CLI usage](#cli-usage) +- [Usage](#usage) + - [Runtime keybindings](#runtime-keybindings) + - [CLI arguments](#cli-arguments) - [Default Shaders and Config](#default-shaders-and-config) - [Sources and Effects](#sources-and-effects) - [Debug View](#debug-view) @@ -85,7 +87,17 @@ make make install ``` -## CLI usage +## Usage + +### Runtime keybindings + +When running, the following keybindings are available: + +* Esc: Exit window +* R: Randomize shader state +* D: Demo mode On/Off + +### CLI arguments ```txt usage: forge [-h] [-v] [-hr] [-s=SCREEN] [-m=SCREEN] [-mo] [-f=DIR_PATH] [-c=CFG_PATH] [-sf=STATE_PATH] [-ls / -nls] [-ss / -nss] [-is=SIZE] [-v=FILE] [-vs=SIZE] [-t=TEMPO] [--demo] [-w]