DOC: Add quickstart section how to use CHORAS - #85
Merged
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
The new Quickstart currently contains a few correctness/clarity issues (submodules/requirements) and minor Markdown/spelling fixes that should be addressed before merging.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Adds a “Quickstart” section to the README to help new users run CHORAS locally, complementing the existing links to the full ReadTheDocs documentation.
Changes:
- Added a Quickstart section with Docker + build script instructions for Linux/macOS and Windows.
- Added a Windows note about running the
.batscript via double-click.
File summaries
| File | Description |
|---|---|
| README.md | Introduces a Quickstart section to help users get CHORAS running from the repository entry point. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 4
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add quickstart section how to use CHORAS