I have been playing with this library for a few days now and was finding information scattered across a few places in README files and CI config files. This was slightly confusing, some of the READMEs date back to 2008, and/or conflict with what CI or the current READMEs say.
This pull request is my best attempt to consolidate that information and apply some formatting to make it more approachable.
Happy to make any additional changes needed, I am still not that familiar with the library so I may have overlooked/misinterpreted something
Hello,
I have been playing with this library for a few days now and was finding information scattered across a few places in README files and CI config files. This was slightly confusing, some of the READMEs date back to 2008, and/or conflict with what CI or the current READMEs say.
This pull request is my best attempt to consolidate that information and apply some formatting to make it more approachable. Happy to make any additional changes needed, I am still not that familiar with the library so I may have overlooked/misinterpreted something
Changes include:
clean up and add links to resources:
Add explicit section for platform specific compilation commands
add explicit dependencies section
formatting to make copy/paste easier, remove leading
%dir
in compile instructionsadd CI status badges
add current release version badge to show current release info
delete .github/README.md and move README out to top directory. You can view the changes rendered on my fork