search

grundleborg / slack-advanced-exporter

A tool for exporting additional data from Slack that is missing from the official data export.
MIT License
95 stars 18 forks source link

Adds homebrew installation instructions #7

Closed mkraft closed 6 years ago

mkraft commented 6 years ago

Most macOS users appreciate Homebrew installations because they provide a simple way to install CLI apps from source (rather than from a scary binary), and it makes uninstalls and updates easier too.

However, Homebrew rejects install formulas that don't use Go vendoring and that don't have underlying apps with repos with at least 20 forks.

The easiest way to support Homebrew installations for slack-advanced-exporter without those criteria is to fork mkraft/homebrew-slack-advanced-exporter to github.com/grundleborg and then merge this pull request to update the docs.

I think that's the easiest I can make it.

grundleborg commented 6 years ago

Is it normal for the homebrew recipe to be in a separate repository to the actual source code when it isn't in the upstream homebrew repo? Just curious, as I know nothing about homebrew at all.

mkraft commented 6 years ago

Yes it's common and the reason is that one is required to name the repo with the "homebrew-" prefix in order to avoid passing a second (URL) parameter to the tap command.

Here's an example of pivotal labs using a separate repo:

https://github.com/pivotal/homebrew-tap allows users to "tap" the formulas with brew tap pivotal/tap.

And here's what the command would look like if you kept the formula in the main repo:

brew tap grundleborg/slack-advanced-exporter https://raw.githubusercontent.com/grundleborg/slack-advanced-exporter/master/slack-advanced-exporter.rb (or maybe it's the non-raw URL, but you get the picture).

It's not wrong it's just a less common (and more verbose) syntax. Both do the install with 2 commands. You can choose whichever you're more comfortable with of course and just use the appropriate install documentation in the readme.