New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #300

Closed
wants to merge 1 commit into
base: master
from

Conversation

2 participants
@frob
Copy link

frob commented Jan 18, 2019

Add installation instructions to readme.

Update README.md
Add installation instructions to readme.
@fabiospampinato

This comment has been minimized.

Copy link
Member

fabiospampinato commented Jan 18, 2019

Thanks for the contribution but half of this is basically overlapping the the huge "DOWNLOADS" link at the top of the readme, and the brew command installs a version I'm not maintaining myself.

Let's provide better installation instructions once there a website up and running.

@frob

This comment has been minimized.

Copy link
Author

frob commented Jan 18, 2019

Thanks for the quick response, I always expect my random PRs to just site around for long periods of time. I was about to write up an issue for the PR, but you beat me to it. :)

the brew command installs a version I'm not maintaining myself.

I am not sure what you mean by that. My brew log shows the location of the download as https://github.com/fabiospampinato/notable/releases/download/v1.1.0/Notable-1.1.0-mac.zip isn't that the artifact created by your project?

==> Downloading https://github.com/fabiospampinato/notable/releases/download/v1.1.0/Notable-1.1.0-mac.zip
==> Downloading from https://github-production-release-asset-2e65be.s3.amazonaws.com/162815665/91f37380-0f8c-11e9-953d-c281ae2adca2?X-Amz-Algorithm=AWS4-HMAC
######################################################################## 100.0%
==> Verifying SHA-256 checksum for Cask 'notable'.
==> Installing Cask notable
==> Moving App 'Notable.app' to '/Applications/Notable.app'.
🍺  notable was successfully installed!

Let's provide better installation instructions once there a website up and running.

Agreed, my wording isn't great and a website (and more OS instructions) would be better. It took me a couple of minutes to find the giant downloads link at the top, and there is nothing pointing out that the downloads are for installation.

@fabiospampinato

This comment has been minimized.

Copy link
Member

fabiospampinato commented Jan 18, 2019

isn't that the artifact created by your project?

You're right. I meant to say that I don't control what gets installed. I'm not super familiar with how Brew works, and if the formula is maintained by somebody else or by the community as a whole, either way I'm not maintaining it.

Which is not to say that I don't "trust" those installations, but I should be maintaining them if I have to endorse.

It took me a couple of minutes to find the giant downloads link at the top, and there is nothing pointing out that the downloads are for installation.

IMHO that should be pretty clear, obviously relying on a GitHub's readme for this almost automatically cuts off most non-technical people, that will be fixed properly with a website.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment