Update README

[bwbohl]

with information on new build-setup and local build instructions
closes: #763

[bwbohl]

@martha-thomae could you please add the documentation of how to build using oXygen XML?

[musicEnfanthen]

Thanks for taking care of this important documentation!

[musicEnfanthen]

Thanks a lot!

Added some more comments while going through the file again (please discard anything you think is unnecessary).

[bwbohl]

Moreover the section on Validation is outdated

[bwbohl]

Working on this I get the impression it's a bit long for a README and probably should be split int several files after all content is up to date. What do you thing @musicEnfanthen?

[musicEnfanthen]

Thanks a lot, @bwbohl !

Working on this I get the impression it's a bit long for a README and probably should be split int several files after all content is up to date. What do you thing @musicEnfanthen?

Not sure about that. There are much longer READMEs out there, and it's nice to have the most important information/instruction in one place. But of course, splitting things up can improve readability and overall structure (especially when it comes to different, independent build scenarios). E.g. Verovio's README follows such an approach: https://github.com/rism-digital/verovio#building-and-use-instructions-by-environment

Maybe it's an idea to stick with the one document for this PR, to have all the phrasings and contents updated and included, and to have another PR then to split things up?

[bwbohl]

@musicEnfanthen is this a go to merge or should we wait for @martha-thomae to add oXygen-specific documentation?

[musicEnfanthen]

Is it technically possible to include @martha-thomae's additions in the same PR?

[bwbohl]

Is it technically possible to include @martha-thomae's additions in the same PR?

Yes, if she clones https://github.com/music-encoding/music-encoding/tree/local-build-instructions and commits her changes there, they would automatically get part of this PR

[martha-thomae]

Is it technically possible to include @martha-thomae's additions in the same PR?

Yes, if she clones https://github.com/music-encoding/music-encoding/tree/local-build-instructions and commits her changes there, they would automatically get part of this PR

Hi! Thanks for all your work on this @bwbohl, and thanks @musicEnfanthen for your detailed review of this PR. Looks awesome! I will focus on reviewing the building instructions then.

I would prefer if you wait for me to include the information for Oxygen, so that everything in issue #763 gets resolved in the same PR. I will make these changes (and evaluate the building instructions @bwbohl provided) closer to the ODD Meeting, though (I have so many deadlines in March). So, if you prefer to merge now, and for me to make the changes later in a new PR, that is fine too.

[bwbohl]

thx @martha-thomae for adding and reviewing!

[ahankinson]

Thank you all for having a look at this. One section that I noticed that was missing was (maybe) at the very beginning, to point people to URLs where they can find the pre-built schemas. That would help those people who want to develop with MEI, but don't necessarily want to develop MEI itself.

[martha-thomae]

thx @martha-thomae for adding and reviewing!

No problem, @bwbohl! Your documentation was pretty clear so it was easy to review. Thanks for your work!

[martha-thomae]

Thank you all for having a look at this. One section that I noticed that was missing was (maybe) at the very beginning, to point people to URLs where they can find the pre-built schemas. That would help those people who want to develop with MEI, but don't necessarily want to develop MEI itself.

Perfect, we will add this. Thanks for taking a look, @ahankinson!

[bwbohl]

There's still one TODO that I see here: fixing the section on validation to use current schemata

[kepper]

thanks to everyone involved!