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.

Sign up for GitHub

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

Remove erroneous go install instructions #1022

Merged
merged 4 commits into from
Nov 21, 2023
Merged

Remove erroneous go install instructions #1022

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2b54718
Remove erroneous `go install` instructions
defunctzombie Nov 19, 2023
9e3c84a
Update website/docs/guides/cli.md
defunctzombie Nov 20, 2023
557c512
Update website/docs/guides/cli.md
defunctzombie Nov 20, 2023
f205fcf
Merge remote-tracking branch 'origin/main' into roman/fg-5379-unknown…
defunctzombie Nov 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions go/cli/mcap/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
## MCAP CLI

A command line tool to work with MCAP files. See https://mcap.dev/guides/cli for documentation.

## Build from source

You can build the CLI tool from source by running `make build` in the same directory as this README.

```
$ make build
```

The binary will be built to a `bin` folder in the same directory.
13 changes: 6 additions & 7 deletions website/docs/guides/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,16 @@ To install using [Homebrew](https://brew.sh) on macOS or Linux, run:

$ brew install mcap

### Using Go
### From Source

:::caution
Installing via 'go install' is not recommended, and is not guaranteed to work.
Installing via `go install` is not supported. To build from source you must clone the repository.
:::

To install from the latest commit, use

$ go install github.com/foxglove/mcap/go/cli/mcap@latest

Ensure that the go installation directory is in your path (e.g. `$HOME/go/bin` by default on Ubuntu).
1. Clone the [mcap repository](https://github.com/foxglove/mcap).
2. `$ cd go/cli/mcap`
3. `$ make build`
4. The binary will be built into the a newly created `bin` folder.

## Usage

Expand Down
Loading