search

OSGeo / libgeotiff

Official repository of the libgeotiff project
180 stars 69 forks source link

consolidate README information #45

Closed Crghilardi closed 3 years ago

Crghilardi commented 3 years ago

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:

  1. clean up and add links to resources:

    • http://geotiff.osgeo.org/ is a circular link back to the github page, removed
    • added links to additional OSGeo sources, mailing list, archived SVN repo

  2. Add explicit section for platform specific compilation commands

    • unsure if I got these all correct, using current CI commands. I am unable to test on windows or Mac

  3. add explicit dependencies section

    • SQLite seems to be outlined in the CI .yml files, but not anywhere else. Unsure if that is explicitly needed or not?

  4. formatting to make copy/paste easier, remove leading %dir in compile instructions

  5. add CI status badges

    • Travis does not seem to be active and Appveyor is currently failing

  6. add current release version badge to show current release info

  7. delete .github/README.md and move README out to top directory. You can view the changes rendered on my fork