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

docs: update help and todo

Browse Source
This commit is contained in:
klemek
2025-11-01 18:46:54 +01:00
parent 4faf4cab30
commit aa0d03381b
2 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+8 -4
View File
@@ -52,7 +52,7 @@ make install
## CLI arguments ## CLI arguments
```txt ```txt
usage: forge [-h] [-v] [-hr] [-s=SCREEN] [-m=SCREEN] [-mo] [-f=DIR_PATH] [-fc=CFG_PATH] [-is=SIZE] [-mf=FACTOR] [-t=TEMPO] [--demo] [-w] usage: forge [-h] [-v] [-hr] [-s=SCREEN] [-m=SCREEN] [-mo] [-f=DIR_PATH] [-c=CFG_PATH] [-is=SIZE] [-v=FILE] [-vs=SIZE] [-t=TEMPO] [--demo] [-w]
Fusion Of Real-time Generative Effects. Fusion Of Real-time Generative Effects.
@@ -64,9 +64,10 @@ options:
-m, --monitor monitor screen number (default: none) -m, --monitor monitor screen number (default: none)
-mo, --monitor-only no output screen -mo, --monitor-only no output screen
-f, --frag fragment shaders directory (default: TODO) -f, --frag fragment shaders directory (default: TODO)
-fc, --frag-config fragment shaders config file (default: TODO) -c, --config fragment shaders config file (default: TODO)
-is, --internal-size internal texture height (default: 720) -is, --internal-size internal texture height (default: 720)
-mf, --monitor-factor monitor internal texture downscale factor (default: 3) -v, --video-in path to video capture device (multiple allowed)
-vs, --video-size video capture desired height (default: internal texture height)
-t, --tempo base tempo (default: 60) -t, --tempo base tempo (default: 60)
--demo demonstration mode --demo demonstration mode
-w, --windowed not fullscreen -w, --windowed not fullscreen
@@ -153,4 +154,7 @@ make -f Makefile.dev release-arch
- [ ] Other - [ ] Other
- [ ] Update readme with usage documentation - [ ] Update readme with usage documentation
- [ ] Clone "shaders" and config in system path at setup - [ ] Clone "shaders" and config in system path at setup
- [ ] Find and fix opengl errors 0500 ? - [ ] Find and fix opengl errors 0500 ?
- [ ] Bonus
- [ ] Record show as text files
- [ ] Play from record text file
src/args.c
+1 -1
View File
@@ -39,7 +39,7 @@ static void print_help(int status_code) {
" -m, --monitor monitor screen number (default: none)\n" " -m, --monitor monitor screen number (default: none)\n"
" -mo, --monitor-only no output screen\n" " -mo, --monitor-only no output screen\n"
" -f, --frag fragment shaders directory (default: TODO)\n" " -f, --frag fragment shaders directory (default: TODO)\n"
" -c, --config fragment shaders config file (default: " " -c, --config fragment shaders config file (default: "
"TODO)\n" "TODO)\n"
" -is, --internal-size internal texture height (default: 720)\n" " -is, --internal-size internal texture height (default: 720)\n"
" -v, --video-in path to video capture device (multiple " " -v, --video-in path to video capture device (multiple "