Using examples is not documented/idiot-proof
Nobody has claimed this yet.
- Dominant language
- GLSL
- Stars
- 17
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
I downloaded Ossia and opened it for the first time and wanted to take a look at some of the examples. Clicking "Examples" on the load screen takes me to this repo, which has a bunch of .score files, which seem to be some kind of json like thing, but what do I do with these? how do I get them to open in Ossia? This should be in the .readme -- I like all the stuff about code of conduct and community contribution and individual responsibility, super nice, but also a handholding 1-2-3 would be great (download the zip and put it somewhere? where?)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the repository README and the Examples link described in the issue. Document where to obtain the example archive, where to place it, and how to open the .score files in Ossia; done means a first-time user can follow the steps from download to viewing an example.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100