search

steve8x8 / geotoad

Geocaching query tool written in Ruby
https://buymeacoffee.com/steve8x8
Other
28 stars 8 forks source link

Github-friendly README and Homebrew formula. #340

Closed vitorgalvao closed 7 years ago

vitorgalvao commented 7 years ago

This PR changes the README to a markdown file, formatted to take advantage of github’s markdown features. In my view, that always lends credibility to a project.

It also adds a Homebrew formula for easy installation on macOS. I’ve also submitted it to the main repo but I’m pretty sure it will not be included. The only maintenance you need to do on on this is simply update the url "https://github.com/steve8x8/geotoad/archive/3.25.4.tar.gz" line to the new download and the sha256 "6c30bb7ce6ae552b4146ac1c228c18c9e3cf318860ff0fc709cee803406ce900" to the new shasum (shasum --algorithm 256 {{tar.gz file}}).

I’ll gladly make the update if you need, or even make a script to automate it.

steve8x8 commented 7 years ago

As README.md was already in the wiki section, and (at least to me) it makes little sense to distribute a .md file with the tarball (time will tell). I'm working on the wiki pages, to be able to create .txt files from them. For your homebrew suggestion which you had chosen not to separate from the README PR I have opened issue 341, pointing to your original tap. At the moment I cannot test it, therefore I won't merge it. As it has to be kept separate anyway, there's no big deal leaving it where it is now, right? Thanks for the update to 3.25.5 btw!

vitorgalvao commented 7 years ago

Thank you. Added details to #341.