Improve ReadMe
- Dominant language
- JavaScript
- Stars
- 172
- Forks
- 109
- PR merge metrics
- No merged PRs in 30d
Description
ReadMe of Origami is not descriptive of what Origami is and how it works.
Todo -
- [x] Add small description about Origami.
- [ ] Make a flowchart on how Origami interacts with Demo Models and with Origami-library.
- [ ] Add a video description on how to make a full working demo using Origami.
Contributor guide
Research direction
Start with the repository README and review how Origami interacts with Demo Models and Origami-library. Create a flowchart covering those interactions and add a video description showing how to make a full working demo using Origami. Done means both unchecked documentation tasks are completed and the README explains what Origami is and how it works.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100