docs: improve readme formatting

[Calinou]

This makes the README follow a more conventional structure, while also adding Homebrew installation instructions.

[lwouis]

Thanks for contributing! I didn't know someone put this app on homebrew. If the readme is going to mention homebrew as an install method, then I want to make sure it is properly maintained. I just checked and saw for instance:

Requires: macOS >= 10.14

Which is incorrect. The app runs on 10.12-10.15.

Also from looking at this file history on the official Homebrew cask repo, it seems the versions are currently manually bumped which is something I want to avoid. I will check if there is a way to link releases to github releases to automate that process.

When these 2 issues are fixed with Homebrew, I will merge this PR

Update: I checked brew cask documentation and it seems their system is designed for manual submissions. I don't want to promote an install channel that has obsolete releases. At that point I would rather suggest curl + unzip + cp given how easy it is to download the latest version from Github releases and unzip it in the Applications folder.

Does anyone know how I could automate release on brew somehow? Maybe there is an unofficial tool or CI hook I could add? I opened a ticket on brew cask repo to ask for help.

[lwouis]

Hey @Calinou I think the best way to more forward is that you remove the mention to homebrew from this PR. Then I merge it. Then you open a ticket about integrating with Homebrew, which is its own topic. Then within that ticket, we can document it.

Based on the discussion in this ticket, I think the scope of having automated releasing in brew cask is non-trivial and would block the current PR for a long time if we don't have brew be its own independent ticket

[Calinou]

@lwouis Done 🙂 I also added instructions to bypass Gatekeeper (I had to do this here, as it seems the app isn't signed).

[lwouis]

I'm sorry I forgot to ask you: could you please change the commit message to something like docs: improve readme formatting?

The commit message has to adhere to a convention used to auto-generate releases and changelogs as part of semantic-release.

Right now if I merged it would break releasing :/

[lwouis]

@lwouis Done 🙂 I also added instructions to bypass Gatekeeper (I had to do this here, as it seems the app isn't signed).

Oh very nice, thank you! There is a ticket to add signing #13 but someone needs to be paying for an Apple Developer account and kind of "own" the app to enable signing, which goes a bit against the OSS spirit. That being said I may just do it for users convenience. It's low on my priority list right now though tbh