Skip to content
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

Super-fy the Installation doc #5408

Merged
merged 4 commits into from
Oct 31, 2024
Merged

Super-fy the Installation doc #5408

merged 4 commits into from
Oct 31, 2024

Conversation

philrz
Copy link
Contributor

@philrz philrz commented Oct 31, 2024

In the same spirit as #5368.

Since this doc references the Homebrew installation, I took the liberty of also updating the description of super that will appear in Homebrew to match the latest text that @mccanne put on the super repo.

@philrz philrz self-assigned this Oct 31, 2024
@philrz philrz requested a review from a team October 31, 2024 19:41
architectures in the Zed [Github Release page](https://github.com/brimdata/super/releases).

Each archive includes the build for `zq` and `zed`.
We offer pre-built binaries for macOS, Windows and Linux for both amd64/x86 and arm
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I figured we might as well mention "amd64" explicitly since that's actually the architecture name that appears in the download artifacts on GitHub.

docs/install.md Show resolved Hide resolved
@philrz philrz changed the title Docs installation Super-fy the Installation doc Oct 31, 2024
Copy link
Collaborator

@mccanne mccanne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool!

docs/install.md Outdated
`zq` and `zed` are easy to test as they are completely self-contained
command-line tools and require no external dependendies to run.
`super` is easy to test as it's a completely self-contained
command-line tool and requires no external dependencies to run.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

drop "to run"?

@philrz philrz merged commit 59e8fc0 into main Oct 31, 2024
4 checks passed
@philrz philrz deleted the docs-installation branch October 31, 2024 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants