Github-friendly README and Homebrew formula.

[vitorgalvao]

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.

[vitorgalvao]

OS X is now called macOS.

[steve8x8]

According to Wikipedia (1) the "Mac" prefix was dropped in 2012 (release 10.8), and (2) the renaming to "macOS" will happen in fall 2016 (with release 10.12). GeoToad is supposed to work with "sufficiently recent" OS versions - which would not exclude OS X <= 10.11.

[vitorgalvao]

Yes, but why not change it now? It’s going to be like this in two months anyway and no one will be confused by it now.

[steve8x8]

Another note: Did you notice that a README.md already exists (in the wiki section) which has to be "textified" to produce the README file in the tarball? (A md2txt converter would be highly appreciated.)
Yes, there is some duplication, due to the later addition of wiki pages - which now are supposed to be the primary source of information. People won't be happy to off-line read md pages, so we'll probably have to keep the dupes.

[vitorgalvao]

A md2txt converter would be highly appreciated.

mv file.md file.txt

That’s the whole point of markdown. It is still a text file, and as readable as one even if you don’t know the syntax. There are tools to remove all the formatting, but that does not make much sense in the context of markdown.

Regarding the README, what exactly should be done, then? Why have duplication? If you prefer the wiki, why not have minimal information here that just says “check the wiki”?

[vitorgalvao]

You manually update this url and the below sha256 (shasum --algorithm 256 on the archive) and its done. It’s only updated for whatever version you want.

[steve8x8]

Do I smell a chicken-and-egg problem here? Tagging a whole tree will produce an archive which has to be checksummed, and the checksum to be merged into a file that has been tagged. As a result, the tag won't be consistent anymore. Re-tag? Slim chance...

[vitorgalvao]

You’re right. The correct approach is to create a tap, meaning a new repo (steve8x8/homebrew-geotoad) and inside put this file.

Since I cannot PR a repo creation, I submitted it like this, but forgot about that problem that makes it impossible with the way you package (you only release the source and don’t do an actual release wit notes and the download file).

Are you interested in creating said repo (so I know how to edit this)?

[vitorgalvao]

I’ve created the repository/tap and sent you a transfer request. If you accept it, it will be under your account, and you edit that file instead.

If you accept, will make the necessary changes to the README for the new installation process, as well as delete this file (and enclosing directory) from this PR.

[steve8x8]

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]

Thank you. Added details to #341.