Update README with project details and structure#29
Conversation
Added detailed project description, goals, current status, example output, roadmap, tech stack, and author information.
There was a problem hiding this comment.
Pull request overview
Expands the project README to provide a clearer description of the CARLA Observability Toolkit, its goals, current status, planned roadmap, and basic output artifacts.
Changes:
- Replaces the minimal README title with a full project overview and goals.
- Adds sections for current status, example output artifacts, roadmap, tech stack, and author info.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| metrics.csv | ||
| events.json | ||
| run_metadata.json |
There was a problem hiding this comment.
The “Example files produced during a simulation run” items are plain lines, which Markdown will typically collapse into a single paragraph. Consider formatting these as a bullet list or a fenced code block so each filename renders on its own line.
| metrics.csv | |
| events.json | |
| run_metadata.json | |
| - `metrics.csv` | |
| - `events.json` | |
| - `run_metadata.json` |
| 🚧 Work in progress | ||
|
|
There was a problem hiding this comment.
“🚧 Work in progress” is stated both at the top of the README and again under “Current Status”. Consider keeping it in one place to avoid redundant status indicators that can drift over time.
| 🚧 Work in progress |
|
|
||
| ## Author | ||
|
|
||
| Cameron Basham |
There was a problem hiding this comment.
There’s trailing whitespace after the author name, which can trigger markdown linting/pre-commit whitespace checks. Remove the extra space (and keep intentional hard line breaks using the two-space convention only where needed).
| Cameron Basham | |
| Cameron Basham |
|
|
||
| - Python | ||
| - CARLA Simulator | ||
| - Pygame client |
There was a problem hiding this comment.
In the Tech Stack list, consider using the package name casing (“pygame”) rather than “Pygame” to match the import/module name and typical dependency naming (helps readers install the right thing).
| - Pygame client | |
| - pygame client |
|
@copilot open a new pull request to apply changes based on the comments in this thread |
Co-authored-by: Dumpy250 <83517134+Dumpy250@users.noreply.github.com>
[WIP] Update README with project details and structure
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@copilot approve this |
Respond to README review: clarify PR approval limitation
Added detailed project description, goals, current status, example output, roadmap, tech stack, and author information.