Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve documentation #148

Open
jsbean opened this issue Oct 13, 2019 · 2 comments
Open

Improve documentation #148

jsbean opened this issue Oct 13, 2019 · 2 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Milestone
0.4.0

Comments

@jsbean
Copy link
Member

jsbean commented Oct 13, 2019

Add some examples of parsing, manipulating, and exporting very basic MusicXML samples to the README.
@jsbean jsbean added the enhancement New feature or request label Oct 13, 2019
@jsbean jsbean added this to the 0.4.0 milestone Oct 13, 2019
@jsbean
Copy link
Member Author

jsbean commented Oct 13, 2019 •
edited
Loading

Important concepts to discuss are:

  • The structure of the MusicXML.Score
  • How/why does Traversal work?
  • Partwise / Timewise
  • Partwise.Measure vs. Timewise.Measure (and *.Part)
  • How to build the "Hello, World!" from scratch
  • …and more…

@jsbean jsbean added good first issue Good for newcomers help wanted Extra attention is needed labels Oct 13, 2019
@jsbean
Copy link
Member Author

jsbean commented Oct 16, 2019

We should use jazzy to generate docs automatically from the codebase.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
0.4.0
Development

No branches or pull requests
1 participant
@jsbean