Skip to content

fix(#5566): updated two docs to make build steps clearer #5568

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

fix(#5566): updated two docs to make build steps clearer #5568

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bc9b599
Added clarification to agave-install instructions
aRustyDev Mar 30, 2025
7e23621
Added instructions for building on macOS
aRustyDev Mar 30, 2025
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
14 changes: 13 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,20 @@ $ cd agave
$ ./cargo build
```

## **3a. Build. (macOS)**

```bash
$ # Install build dependencies
$ brew install pkg-config libudev protobuf llvm coreutils
Copy link

Choose a reason for hiding this comment

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

wdyt about moving this line a lil bit higher, just after On Fedora: paragraph?

Copy link
Author

Choose a reason for hiding this comment

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

Yeah good point, that makes more sense and flows better

$ ./scripts/cargo-install-all.sh . # This takes a while ~45m

# Include the installed bins in your PATH
$ export PATH=$PATH:$PWD/bin
$ ./cargo build
Copy link

Choose a reason for hiding this comment

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

cargo-install-all.sh contains building so extra ./cargo build shouldn't be applied

Copy link
Author

@aRustyDev aRustyDev Mar 31, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

@sonicfromnewyoke I put that there mostly for clarity that from this point the developer can start running the ./cargo build again as they make changes. But if I misunderstood the use case of a local cargo definition then I can remove it?

```

> [!NOTE]
> Note that this builds a debug version that is **not suitable for running a testnet or mainnet validator**. Please read [`docs/src/cli/install.md`](docs/src/cli/install.md#build-from-source) for instructions to build a release version for test and production uses.
> Note that these steps build a debug version that is **not suitable for running a testnet or mainnet validator**. Please read [`docs/src/cli/install.md`](docs/src/cli/install.md#build-from-source) for instructions to build a release version for test and production uses.

# Testing

Expand Down
1 change: 1 addition & 0 deletions docs/src/cli/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,7 @@ export PATH=$PWD/bin:$PATH
You can then run the following command to obtain the same result as with
prebuilt binaries:

> NOTE: this is only to install the `test` or `prod` versions, and expects you to download a source archive from the **[Releases](https://github.com/anza-xyz/agave/releases/latest)** page, it will not help you build the `debug` version of agave. It is possible to instead switch to a tagged release on the repo though.
```bash
agave-install init
```
Expand Down