Skip to content

README.md fix for git submodule sync & --version / --help#45

Merged
jamylak merged 2 commits intomainfrom
help-cli
Jan 13, 2026
Merged

README.md fix for git submodule sync & --version / --help#45
jamylak merged 2 commits intomainfrom
help-cli

Conversation

@jamylak
Copy link
Copy Markdown
Owner

@jamylak jamylak commented Jan 13, 2026

  • README.md fix for git submodule sync
  • --version
  • --help

@jamylak jamylak added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 13, 2026
@jamylak jamylak marked this pull request as ready for review January 13, 2026 12:36
Copilot AI review requested due to automatic review settings January 13, 2026 12:36
@jamylak jamylak merged commit 98ee883 into main Jan 13, 2026
8 checks passed
@jamylak jamylak deleted the help-cli branch January 13, 2026 12:38
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds command-line help and version flags to the vsdf tool, and improves the documentation by adding git submodule initialization instructions to all build sections.

Changes:

  • Added --help and --version command-line flags to src/main.cpp
  • Added git submodule update --init --recursive commands to all build and test sections in README.md
  • Added a new "Populate submodules" section as step 0 in QUICKSTART.md

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
src/main.cpp Adds --help and --version flags with supporting functions, and includes spdlog/fmt/fmt.h for formatted output
README.md Adds git submodule initialization command before all cmake build commands (4 locations: Linux/macOS build, Windows build, Linux/macOS test build, Windows test build)
QUICKSTART.md Adds a dedicated "0) Populate submodules" section with the git submodule command at the beginning of the quickstart guide

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +20 to +22
fmt::print("Usage: {} [options] <shader.frag>\nExample: {} --toy "
"shaders/testtoyshader.frag\n",
exe, exe);
Copy link

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The printHelp function only shows a basic usage example with the --toy option, but doesn't document other available flags like --headless, --frames, --log-level, --debug-dump-ppm, or the FFmpeg-related options that are listed in the README. Consider expanding the help text to include all available command-line options, or at least the most commonly used ones, to make the tool more discoverable for users.

Suggested change
fmt::print("Usage: {} [options] <shader.frag>\nExample: {} --toy "
"shaders/testtoyshader.frag\n",
exe, exe);
fmt::print(
"Usage: {} [options] <shader.frag>\n"
"\n"
"Options:\n"
" --toy Use Shadertoy-style template for the fragment shader\n"
" --headless Run without creating a window (offscreen rendering)\n"
" --frames <N> Limit the number of frames to render before exiting\n"
" --log-level <LEVEL> Set log verbosity (trace, debug, info, warn, error, critical, off)\n"
" --debug-dump-ppm <DIR> Dump rendered frames as PPM files into directory DIR\n"
#if defined(VSDF_ENABLE_FFMPEG)
" [FFmpeg] Additional FFmpeg encoding options are available; see README\n"
#endif
"\n"
"Example:\n"
" {} --toy shaders/testtoyshader.frag\n",
exe, exe);

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants