docs: unify README, setup guide, and description#1
Conversation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 543829ae77
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| ```bash | ||
| # Generate a 20×20 maze and save it | ||
| ./build/mazelib generate --width 20 --height 20 --algorithm dfs --output maze.dat |
There was a problem hiding this comment.
With the documented mkdir build && cd build && cmake .., CMakeLists.txt sets CMAKE_RUNTIME_OUTPUT_DIRECTORY to ${CMAKE_BINARY_DIR}/../target, so from the repo root the built CLI is ./target/mazelib, not ./build/mazelib. As written, this and the following usage examples fail before reaching the CLI after a normal build.
Useful? React with 👍 / 👎.
|
|
||
| ```bash | ||
| # Generate a 20×20 maze and save it | ||
| ./build/mazelib generate --width 20 --height 20 --algorithm dfs --output maze.dat |
There was a problem hiding this comment.
Even after fixing the executable path, this sample cannot generate the saved maze it describes: checked mazelib generate --help, which lists -f/--file and -i/--image only, not --output, and mazelib algorithms -d shows Kruskal is the only generating algorithm, so --algorithm dfs exits with No algorithm was found. The example should use the real generator and file flag, e.g. --algorithm kruskal --file maze.dat.
Useful? React with 👍 / 👎.
| ./build/mazelib generate --width 20 --height 20 --algorithm dfs --output maze.dat | ||
|
|
||
| # Solve a saved maze | ||
| ./build/mazelib solve --file maze.dat --algorithm dijkstra |
There was a problem hiding this comment.
Checked mazelib solve --help: the required input option is -fi/--fileIn, while --file is not registered for solve. Users following this command get Missing required argument 'fileInput', so the saved-maze example should pass --fileIn maze.dat and optionally --fileOut or --image for output.
Useful? React with 👍 / 👎.
| ./build/mazelib generate --width 30 --height 30 --algorithm kruskal --image maze.png | ||
|
|
||
| # Benchmark all algorithms on a 50×50 maze | ||
| ./build/mazelib test --width 50 --height 50 |
There was a problem hiding this comment.
Checked mazelib test --help: test requires -fi/--fileIn and has no --width or --height options, so this benchmark example immediately reports the missing input file instead of creating a 50×50 maze. Update it to first generate a maze file and then call test --fileIn ... if the README is meant to be runnable.
Useful? React with 👍 / 👎.
| ./build/mazelib test --width 50 --height 50 | ||
|
|
||
| # List available algorithms | ||
| ./build/mazelib list |
There was a problem hiding this comment.
Checked the top-level help: the command for listing algorithms is algorithms with aliases algs and algos; there is no list command, and running this example hits the unknown-command handler. Replace it with one of the registered command names so the usage block remains copy-pasteable.
Useful? React with 👍 / 👎.
1 participant
Standardizes the README format and updates the repository description for consistency across all public repositories.
Changes: