Add brew installation notice to the README#991
Conversation
70b98a5 to
b70e9ed
Compare
b70e9ed to
edaefc1
Compare
|
ping @Davidson-Souza |
| ## Running | ||
|
|
||
| Currently, Floresta is only available for installation on Linux and MacOS via | ||
| the [`brew`](https://formulae.brew.sh/formula/floresta) package manager. | ||
|
|
||
| To install and run it: | ||
|
|
||
| ```shell | ||
| ~$ brew install floresta | ||
|
|
||
| ~$ florestad | ||
| ``` | ||
|
|
||
| Alternatively, you can build it from source. Refer to the build instructions | ||
| for [Unix](doc/build-unix.md) or [MacOS](doc/build-macos.md). | ||
|
|
There was a problem hiding this comment.
Sorry but i dont think install instructions should be on README like that, it should be on doc/installing.md or in a proper doc/installing-macos.md... Strange that doc/installing.md is actually a tutorial to install on debian based dists but appears to be a generic thing
There was a problem hiding this comment.
We need to pretty much overhaul all documentation.
This should be on the main page so people can go to the repo and immediately see how to install it using a package manager. It's succinct, so no need to have that there.
There was a problem hiding this comment.
We need to pretty much overhaul all documentation.
That could be discussed in a proper PR or issue for that, the current design for documentation follows a parity with how bitcoin core document things, the current structure was already achieved by an "overhaul" not so long time ago.
This should be on the main page so people can go to the repo and immediately see how to install it using a package manager. It's succinct, so no need to have that there.
I agree with you in the point where this should be clearly exposed but we have a structure to follow here in what concerns documentation, changing things on the go will not provide us any stability or any structure to stick with.
| Currently, Floresta is only available for installation on Linux and MacOS via | ||
| the [`brew`](https://formulae.brew.sh/formula/floresta) package manager. |
There was a problem hiding this comment.
This is simply not true, installing it trough cargo is broken but you can install it following doc/installing.md using the install script and even using nix too (The way i use it on my setup)...
There was a problem hiding this comment.
Does cargo install floresta work? There's no usable published package on crates.io yet. I don't consider cargo install --git <$FLORESTA_REPO> as installing through a package manager.
|
Pushing back firmly here, because I think the "only way to install" framing is procedurally indefensible and I want the case on the record before the PR moves forward. Every line of code in this project goes through team review and acknowledgment. Install instructions should not be the exception. The Homebrew formula was written, reviewed, and merged outside this organisation, by people we did not nominate neither have control to. That is not a comment on whoever opened this PR or wrote the brew formula — I trust @luisschwab intent, assuming he was the one to upstream the formula to homebrew. Structurally, the formula is owned by Floresta's Team. An acceptable way for this would be adding it as a community maintained install method as it is done is numerous open source project and even like that i think its unsafe to do so. This also matches owr reference, Bitcoin Core's official download page, which lists only signed binaries from their own infrastructure, source code, and reproducible builds — no Homebrew, no apt, no third-party package managers. If the reference implementation of the network doesn't elevate third-party install paths to canonical, neither should we. A canonical install path — one we do not explicitly flag as community-maintained — should be ownable by this organisation and modifiable only by it. Brew gives us neither. Anyone with a GitHub account can open a PR to This project already maintains several in-org install paths, all of which we control and review:
If anything in this ecosystem has a claim to "canonical," it is one of these — not a third-party formula we have no ownership. Documenting On I'm not arguing brew should be removed from the docs. I'm arguing it should be one option among others — alongside the in-org paths above — not elevated to "the way to install Floresta." |
Floresta is now available as a brew formula.
Changelog