Improve main README file
Open
Beginner friendly
documentation
- Dominant language
- Python
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
### Summary
- [ ] Improve README file to be consistent with the rest of the maliput packages.
- [ ] Provide installation instructions.
- [ ] Provide usage instructions.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the main README in maliput_sim and compare it with the README files in the other maliput packages. Add installation and usage instructions and align the presentation with those packages. Done means all three checklist items are addressed in the README.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100