From 9047a529d40e8ac01b618df338f7a1101fbc4482 Mon Sep 17 00:00:00 2001 From: Steven McCanne Date: Fri, 30 Jan 2026 13:27:33 -0800 Subject: [PATCH 1/2] update install docs with download links from GitHub releases --- book/src/getting-started/install.md | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/book/src/getting-started/install.md b/book/src/getting-started/install.md index d53b6390b..8e5e9c74b 100644 --- a/book/src/getting-started/install.md +++ b/book/src/getting-started/install.md @@ -1,11 +1,16 @@ # Installation -SuperDB, along with its new query language [SuperSQL](../super-sql/intro.md), -is downloadable software available as a single binary embodied in -the [super](../command/super.md) command. - -You can [install a pre-built binary](#homebrew) -or [build from source code](#building-from-source). +SuperDB is downloadable software available as a single binary embodied +in the [super](../command/super.md) command. This software includes support +for [SuperSQL](../super-sql/intro.md), +SuperDB's new query language for super-structured data. + +Several options for installation are available: +* download and install pre-built binaries via links on the + [GitHub Releases page](https://github.com/brimdata/super/releases/tag/v0.1.0), +* automatically install a pre-built binary for a Mac or Linux environment + with [HomeBrew](#homebrew), or +* [build from source code](#building-from-source). To install the SuperDB Python client, see the [Python library documentation](../dev/libraries/python.md). @@ -17,15 +22,9 @@ On macOS and Linux, you can use [Homebrew](https://brew.sh/) to install `super`: ```bash brew install --cask brimdata/tap/super ``` -Once installed, run a [quick test](hello-world.md). ## Building From Source ->[!TIP] -> If you don't have Go installed, download and install it from the -> [Go install page](https://golang.org/doc/install). Go 1.24 or later is -> required. - With Go installed, you can easily build `super` from source: ```bash @@ -34,6 +33,11 @@ go install github.com/brimdata/super/cmd/super@main This installs the `super` binary in your `$GOPATH/bin`. +>[!TIP] +> If you don't have Go installed, download and install it from the +> [Go install page](https://golang.org/doc/install). Go 1.24 or later is +> required. + ## Try It Once installed, run a [quick test](hello-world.md). From 20f7f524f3ec3dd4b9ad51e4b1f9ed4952a18d2a Mon Sep 17 00:00:00 2001 From: Steven McCanne Date: Fri, 30 Jan 2026 13:39:42 -0800 Subject: [PATCH 2/2] address PR feedback --- book/src/getting-started/install.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/book/src/getting-started/install.md b/book/src/getting-started/install.md index 8e5e9c74b..9febefc64 100644 --- a/book/src/getting-started/install.md +++ b/book/src/getting-started/install.md @@ -7,9 +7,9 @@ SuperDB's new query language for super-structured data. Several options for installation are available: * download and install pre-built binaries via links on the - [GitHub Releases page](https://github.com/brimdata/super/releases/tag/v0.1.0), + [GitHub Releases page](https://github.com/brimdata/super/releases), * automatically install a pre-built binary for a Mac or Linux environment - with [HomeBrew](#homebrew), or + with [Homebrew](#homebrew), or * [build from source code](#building-from-source). To install the SuperDB Python client, see the