Skip to content

Commit

Permalink
Document Homebrew package
Browse files Browse the repository at this point in the history
Resolves #2329

Documents the recently added `lighthouse` Homebrew formula.
  • Loading branch information
Richard Patel committed Jan 7, 2022
1 parent ccdc10c commit 3a8ad6d
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 0 deletions.
1 change: 1 addition & 0 deletions book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
* [Build from Source](./installation-source.md)
* [Raspberry Pi 4](./pi.md)
* [Cross-Compiling](./cross-compiling.md)
* [Homebrew](./homebrew.md)
* [Key Management](./key-management.md)
* [Create a wallet](./wallet-create.md)
* [Create a validator](./validator-create.md)
Expand Down
36 changes: 36 additions & 0 deletions book/src/homebrew.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Homebrew package

Lighthouse is available on Linux and macOS via the [Homebrew package manager](https://brew.sh).

Please note that this installation method is maintained by the Homebrew community.
It is not officially supported by the Lighthouse team.

### Installation

Install the latest version of the [`lighthouse`][formula] formula with:

```bash
brew install lighthouse
```

### Usage

If Homebrew is installed to your `PATH` (default), simply run:

```bash
lighthouse --help
```

Alternatively, you can find the `lighthouse` binary at:

```bash
"$(brew --prefix)/bin/lighthouse" --help
```

### Maintenance

The [formula] is kept up-to-date by the Homebrew community and a bot that lists for new releases.

The package source can be found in the [homebrew-core](https://github.com/Homebrew/homebrew-core/blob/master/Formula/lighthouse.rb) repo.

[formula]: https://formulae.brew.sh/formula/lighthouse
4 changes: 4 additions & 0 deletions book/src/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ There are three core methods to obtain the Lighthouse application:
- [Docker images](./docker.md).
- [Building from source](./installation-source.md).

The community maintains additional installation methods (currently only one).

- [Homebrew package](./homebrew.md).

Additionally, there are two extra guides for specific uses:

- [Rapsberry Pi 4 guide](./pi.md).
Expand Down

0 comments on commit 3a8ad6d

Please sign in to comment.