Skip to content
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

Update read me #264

Merged
merged 2 commits into from
Oct 26, 2024
Merged

Update read me #264

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d7e5e4d
added instructions to mac users
lucadg911 Oct 26, 2024
b1854f9
added explanation on ssl certificate error
lucadg911 Oct 26, 2024
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
33 changes: 33 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,37 @@ cargo build --release
cargo install --path ./florestad
```

### Instructions for macOS users
The following steps should be executed in a Terminal application. Tip: press `Command (⌘) + Space` and search for `terminal`.

#### 1. Xcode command line tools

To install, run the following command from your terminal:

``` bash
xcode-select --install
```

Upon running the command, you should see a popup appear.
Click on `Install` to continue the installation process.

#### 2. Homebrew Package Manager

Homebrew is a package manager for macOS that allows one to install packages from the command line easily. You can use the package manager of your preference.

To install the Homebrew package manager, see: https://brew.sh

Note: If you run into issues while installing Homebrew or pulling packages, refer to [Homebrew's troubleshooting page](https://docs.brew.sh/Troubleshooting).

#### 3. Install Required Dependencies

On the Terminal, using Homebrew, run the following:
```bash
brew update
brew install gcc pkg-config openssl
```
* At this point you can proceed from cargo and rust at the previous section.

### Building with nix

If you're using Nix, you can add Florestad to your system with its overlay.
Expand Down Expand Up @@ -121,6 +152,8 @@ floresta-cli getblockchaininfo

For more information on how to use the `floresta-cli` tool, you can check the [api documentation](https://github.com/vinteumorg/Floresta/blob/master/crates/floresta-cli/README.md).

Before running you can create the SSL certificates. If you don't do it, it will display an logging `Failed to load SSL certificates, ignoring SSL`. However, it is not mandatory to have the certificates to run the full node.

#### Assume Utreexo
If you want to skip the IBD process, you can use the `--assume-utreexo` flag. This flag will start the node at a given height, with the state
provided by this implementation. Therefore, you're trusting that we are giving you the correct state. Everything after that height will be
Expand Down