Skip to content

Add README for command-line barcode example#7

Merged
yushulx merged 1 commit intomainfrom
codex/create-readme.md-for-command-line-example
Feb 24, 2026
Merged

Add README for command-line barcode example#7
yushulx merged 1 commit intomainfrom
codex/create-readme.md-for-command-line-example

Conversation

@yushulx
Copy link
Owner

@yushulx yushulx commented Feb 24, 2026

Motivation

  • Provide clear documentation for the command-line example so users can build, run, and validate the sample without inspecting source code.
  • Explain supported input formats, run modes (single file, directory, multiple inputs, interactive), and where required resources are placed after build.

Description

  • Add examples/command-line/README.md with build instructions using CMake and expected executable locations for Linux/macOS/Windows.
  • Document supported file extensions (.jpg, .jpeg, .png, .bmp, .gif, .tif, .tiff, .pdf), run examples for single files, directories, and multiple inputs, and interactive mode usage.
  • Describe output behavior for single files, directories, and combined inputs, and include guidance to replace the embedded trial license key in main.cpp with a production key.
  • List bundled sample files (single_page.tif, multi_page.tif, multi_page.pdf, test.pdf) for quick validation.

Testing

  • Ran CMake configuration to validate the example build instructions with cmake -S examples/command-line -B /tmp/cmake-command-line-build, which completed successfully.

Codex Task

@yushulx yushulx merged commit 551eb3e into main Feb 24, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant