mirror of
https://github.com/hl-archive-node/nanoreth.git
synced 2025-12-06 10:59:55 +00:00
docs: macos install steps (#460)
* Add MacOS installatin docs * move installatio instruction to book * move installatio instruction to book * fix installation link in readme * Remove installation link from docs, add link to installation in book summary Co-authored-by: Satoshi Okamoto <satoshi@butcher73.com>
This commit is contained in:
@ -15,6 +15,7 @@ The book is continuously rendered [here](https://paradigmxyz.github.io/reth/)!
|
|||||||
|
|
||||||
**[Getting Started]()**
|
**[Getting Started]()**
|
||||||
To get started with Reth, install, configure and sync your node.
|
To get started with Reth, install, configure and sync your node.
|
||||||
|
* To install and build reth, you can use the following [installation instruction](./installation.md).
|
||||||
|
|
||||||
**[A Tour Of Reth]()**
|
**[A Tour Of Reth]()**
|
||||||
|
|
||||||
|
|||||||
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
# Getting Started
|
# Getting Started
|
||||||
|
|
||||||
- [Installation]()
|
- [Installation](./installation.md)
|
||||||
- [First Steps with Reth]()
|
- [First Steps with Reth]()
|
||||||
<!-- An overview of all the flags, how they work and how to configure the node -->
|
<!-- An overview of all the flags, how they work and how to configure the node -->
|
||||||
- [Configuring The Node]()
|
- [Configuring The Node]()
|
||||||
|
|||||||
68
book/installation.md
Normal file
68
book/installation.md
Normal file
@ -0,0 +1,68 @@
|
|||||||
|
## Installation
|
||||||
|
|
||||||
|
(still WIP, please contribute!):
|
||||||
|
|
||||||
|
|
||||||
|
### Ubuntu
|
||||||
|
Building the source
|
||||||
|
|
||||||
|
* install rustup
|
||||||
|
```bash
|
||||||
|
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
|
||||||
|
```
|
||||||
|
|
||||||
|
* install Requirements
|
||||||
|
- libclang-dev
|
||||||
|
- pkg-config
|
||||||
|
|
||||||
|
```bash
|
||||||
|
apt install libclang-dev pkg-config
|
||||||
|
```
|
||||||
|
* Build reth
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/paradigmxyz/reth
|
||||||
|
cd reth
|
||||||
|
cargo build --all
|
||||||
|
./target/debug/reth
|
||||||
|
```
|
||||||
|
|
||||||
|
### MacOS
|
||||||
|
|
||||||
|
To install and build reth on macOS using Homebrew, you can use the following steps
|
||||||
|
|
||||||
|
* Install rustup by running the following command in a terminal:
|
||||||
|
```bash
|
||||||
|
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
|
||||||
|
```
|
||||||
|
|
||||||
|
* Install the necessary requirements by running the following command:
|
||||||
|
```bash
|
||||||
|
brew install llvm pkg-config
|
||||||
|
```
|
||||||
|
|
||||||
|
* Clone the reth repository and navigate to the directory:
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/paradigmxyz/reth
|
||||||
|
cd reth
|
||||||
|
```
|
||||||
|
|
||||||
|
* Build reth using cargo:
|
||||||
|
```bash
|
||||||
|
cargo build --all
|
||||||
|
```
|
||||||
|
|
||||||
|
* Run reth:
|
||||||
|
```bash
|
||||||
|
./target/debug/reth
|
||||||
|
```
|
||||||
|
|
||||||
|
* Alternatively, you can use the following one-liner to install and build reth:
|
||||||
|
```bash
|
||||||
|
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh && brew install llvm pkg-config && git clone https://github.com/paradigmxyz/reth && cd reth && cargo build --all && ./target/debug/reth
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### Docker
|
||||||
|
-
|
||||||
|
-
|
||||||
@ -3,5 +3,4 @@
|
|||||||
This directory contains documentation for contributors.
|
This directory contains documentation for contributors.
|
||||||
|
|
||||||
- [Repository and Project Structure](./repo)
|
- [Repository and Project Structure](./repo)
|
||||||
- [Design](./design)
|
- [Design](./design)
|
||||||
- [Installation](./installation)
|
|
||||||
@ -1,26 +0,0 @@
|
|||||||
## Installation
|
|
||||||
|
|
||||||
(still WIP, please contribute!):
|
|
||||||
|
|
||||||
|
|
||||||
### Ubuntu
|
|
||||||
Building the source
|
|
||||||
|
|
||||||
* install rustup
|
|
||||||
```bash
|
|
||||||
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
|
|
||||||
* install Requirements
|
|
||||||
- libclang-dev
|
|
||||||
- pkg-config
|
|
||||||
```bash
|
|
||||||
apt install libclang-dev pkg-config
|
|
||||||
* Build reth
|
|
||||||
```bash
|
|
||||||
git clone https://github.com/paradigmxyz/reth
|
|
||||||
cd reth
|
|
||||||
cargo build --all
|
|
||||||
./target/debug/reth
|
|
||||||
```
|
|
||||||
### Docker
|
|
||||||
-
|
|
||||||
-
|
|
||||||
Reference in New Issue
Block a user