klemek/forge-steel
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 12 Wiki Activity

docs: update README
Clang Lint CI / lint-no-video (push) Successful in 50s
Details
Clang Build CI / run-no-video (push) Successful in 58s
Details
Clang Build CI / run-video (push) Successful in 59s
Details
Clang Build CI / build-release (push) Successful in 1m29s
Details
Clang Lint CI / lint-video (push) Successful in 1m5s
Details

Browse Source
This commit is contained in:
klemek
2026-08-29 12:00:56 +02:00
parent 80add2ec67
commit 2a7d1f6df4
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+12 -12
View File
@@ -133,7 +133,7 @@ make install
```shell ```shell
git clone --recursive https://git.klemek.fr/klemek/forge-steel git clone --recursive https://git.klemek.fr/klemek/forge-steel
cd forge cd forge-steel
makepkg -si makepkg -si
``` ```
@@ -142,11 +142,11 @@ makepkg -si
```shell ```shell
git clone --recursive https://git.klemek.fr/klemek/forge-steel git clone --recursive https://git.klemek.fr/klemek/forge-steel
cd forge cd forge-steel
aclocal aclocal
autoconf autoconf
automake --add-missing automake --add-missing
./configure ./configure --prefix=$HOME/.local
make make
make install make install
``` ```
@@ -174,9 +174,7 @@ These are configurable in the [`forge_project.cfg`](#forge_projectcfg).
### CLI arguments ### CLI arguments
```txt ```txt
forge steel-dev usage: forge [-h] [-v] [-p=PROJECT_PATH] [-c=CFG_FILE] [-hr] [-s=SCREEN] [-m=SCREEN] [-mo] [-w] [-t=TEMPO] [-d] [-ar / -nar] [-arc=CYCLES] [-is=SIZE] [-ls / -nls] [-ss / -nss] [-mr / -nmr] [-tm] [-tf] [--x11] [--wayland] [--cocoa] [--win32] [-as / -nas] [-oma=MAJOR] [-omi=MINOR]
usage: forge [-h] [-v] [-p=PROJECT_PATH] [-c=CFG_FILE] [-hr] [-s=SCREEN] [-m=SCREEN] [-mo] [-w] [-t=TEMPO] [-d] [-ar / -nar] [-arc=CYCLES] [-vi=FILE] [-vs=SIZE] [-vb=COUNT] [-vr / -nvr] [-vf=FOURCC] [-is=SIZE] [-ls / -nls] [-ss / -nss] [-mr / -nmr] [-tm] [-tf]
Fusion Of Real-time Generative Effects. Fusion Of Real-time Generative Effects.
@@ -195,21 +193,23 @@ options:
-ar, --auto-random randomize state every cycle (4 beats) -ar, --auto-random randomize state every cycle (4 beats)
-nar, --no-auto-random do not randomize state (default) -nar, --no-auto-random do not randomize state (default)
-arc, --auto-random-cycle auto random cycle length (default: 4) -arc, --auto-random-cycle auto random cycle length (default: 4)
-vi, --video-in path to video capture device (multiple allowed)
-vb, --video-buffers number of video buffers to use (default: 1)
-vs, --video-size video capture desired height (default: internal texture height)
-vr, --video-reconnect auto-reconnect video (default)
-nvr, --no-video-reconnect do not auto-reconnect video
-vf, --video-fourcc video codec fourcc (default: YUYV)
-is, --internal-size internal texture height (default: 720) -is, --internal-size internal texture height (default: 720)
-ls, --load-state load saved state (default) -ls, --load-state load saved state (default)
-nls, --no-load-state do not load saved state -nls, --no-load-state do not load saved state
-ss, --save-state save state (default) -ss, --save-state save state (default)
-nss, --no-save-state do not save state -nss, --no-save-state do not save state
-as, --auto-save continuously save state (every ~10ms)
-nas, --no-auto-save do not continuously save state (default)
-mr, --midi-reconnect auto-reconnect midi (default) -mr, --midi-reconnect auto-reconnect midi (default)
-nmr, --no-midi-reconnect do not auto-reconnect midi -nmr, --no-midi-reconnect do not auto-reconnect midi
-tm, --trace-midi print midi code and values -tm, --trace-midi print midi code and values
-tf, --trace-fps print fps status of subsystems -tf, --trace-fps print fps status of subsystems
--x11 force X11 GLFW backend
--wayland force Wayland GLFW backend
--cocoa force Cocoa GLFW backend
--win32 force Win32 GLFW backend
-oma, --opengl-major-version OpenGL major version (default: 4)
-omi, --opengl-minor-version OpenGL minor version (default: 6)
``` ```
## Default Project ## Default Project