Skip to content

Add brew installation notice to the README #991

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
luisschwab wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add brew installation notice to the README #991

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 16 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,22 @@ to reuse the same client components across different applications and deployment
Floresta is the Portuguese word for forest. It is a reference to the Utreexo accumulator,
which is a forest of Merkle trees. It's pronounced _/floˈɾɛstɐ/_.

## Running

Currently, Floresta is only available for installation on Linux and MacOS via
the [`brew`](https://formulae.brew.sh/formula/floresta) package manager.
Comment on lines +51 to +52
Copy link
Copy Markdown
Member

@jaoleal jaoleal Apr 27, 2026

Choose a reason for hiding this comment

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

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)...

Copy link
Copy Markdown
Member Author

@luisschwab luisschwab Apr 27, 2026

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Member

@jaoleal jaoleal Apr 27, 2026

Choose a reason for hiding this comment

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

#991 (comment)


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).

Comment on lines +49 to +64
Copy link
Copy Markdown
Member

@jaoleal jaoleal Apr 27, 2026

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Member Author

@luisschwab luisschwab Apr 27, 2026

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Member

@jaoleal jaoleal Apr 27, 2026

Choose a reason for hiding this comment

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

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.

## Architecture

Floresta is written in Rust and implements modern Bitcoin validation techniques such as
Expand All @@ -61,10 +77,6 @@ reusable components that can be integrated into Bitcoin applications.
[`libfloresta`](https://github.com/getfloresta/Floresta/tree/master/crates) to provide a full node
daemon, including a watch-only wallet and an Electrum server.

If you only want to run a node, you can use
[`florestad`](https://github.com/getfloresta/Floresta/tree/master/bin/florestad) by building it from
source, following the instructions for [Unix](doc/build-unix.md) or [MacOS](doc/build-macos.md).

## Consensus Implementation

One of the most challenging parts of working with Bitcoin is keeping up with the consensus rules.
Expand Down
Loading