Update docs and include a powershell setup script
The following changes have been implemented:
- I've updated the README.md file to better reflect a first-time setup
- I've also added a powershell script for those of us so inclined to use that environment
Walkthrough
README now requires cloning submodules and offers multiple Windows setup paths (Setup.bat, scripts/setup.ps1, or running premake5). A new scripts/setup.ps1 PowerShell script was added to run vendor\bin\premake5.exe vs2022 with basic error handling and directory restore.
Changes
| Cohort / File(s) | Summary |
|---|---|
Documentation Updates README.md |
Rewrote Getting Started to recommend git clone --recurse-submodules, added explicit submodule cloning step, replaced the single Setup instruction with multiple Windows setup options (Setup.bat, scripts/setup.ps1, or using vendor\bin\premake5.exe vs2022), fixed a header typo, expanded the 3rd‑party libraries list (Dear ImGui, GLFW, stb_image, GLM noted as included), and kept the Roboto font license note. |
Setup Automation scripts/setup.ps1 |
Added PowerShell setup script that sets $ErrorActionPreference = "Stop", changes to the script directory, attempts to run vendor\bin\premake5.exe vs2022 inside try/catch/finally, prints errors in red, restores the original location, and prompts the user to press Enter. |
Estimated code review effort
🎯 3 (Moderate) | ⏱️ ~20 minutes
- Verify README commands and wording for clarity and correctness (submodule clone, premake vs2022 usage).
- Confirm
scripts/setup.ps1resolves the correct script path and thevendor\bin\premake5.exepath on Windows. - Check error handling behavior (colored output), directory restore via Push/Pop-Location, and the user prompt semantics.
Poem
🐰 I hopped through docs and scripts with care,
Submodules tucked beneath my hair.
I tapped premake’s shoe and watched it spin,
A tidy setup — now build begin! 🥕✨
Pre-merge checks and finishing touches
✅ Passed checks (3 passed)
| Check name | Status | Explanation |
|---|---|---|
| Title check | ✅ Passed | The title accurately describes the main changes: updating documentation (README.md) and adding a PowerShell setup script, which align with the changeset. |
| Description check | ✅ Passed | The description is directly related to the changeset, mentioning README.md updates for first-time setup and the addition of a PowerShell script, matching the actual file changes. |
| Docstring Coverage | ✅ Passed | No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. |
✨ Finishing touches
🧪 Generate unit tests (beta)
- [ ] Create PR with unit tests
- [ ] Post copyable unit tests in a comment
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands and usage tips.