From 65b1374b587483b11475aa37f0bd2899dd7d4bff Mon Sep 17 00:00:00 2001 From: Richard Patel Date: Sat, 8 Jan 2022 01:15:07 +0000 Subject: [PATCH] Document Homebrew package (#2885) ## Issue Addressed Resolves #2329 ## Proposed Changes Documents the recently added `lighthouse` Homebrew formula. ## Additional Info NA Co-authored-by: Richard Patel Co-authored-by: Michael Sproul --- book/src/SUMMARY.md | 1 + book/src/homebrew.md | 36 ++++++++++++++++++++++++++++++++++++ book/src/installation.md | 4 ++++ 3 files changed, 41 insertions(+) create mode 100644 book/src/homebrew.md diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md index 93cec1240..7552d4230 100644 --- a/book/src/SUMMARY.md +++ b/book/src/SUMMARY.md @@ -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) diff --git a/book/src/homebrew.md b/book/src/homebrew.md new file mode 100644 index 000000000..317dc0e0f --- /dev/null +++ b/book/src/homebrew.md @@ -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 diff --git a/book/src/installation.md b/book/src/installation.md index 009bfc00c..38fbe6b78 100644 --- a/book/src/installation.md +++ b/book/src/installation.md @@ -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).