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:
Satoshi Okamoto
2022-12-15 18:55:59 +07:00
committed by GitHub
parent 48fadbdf2e
commit 4c298ac022
5 changed files with 71 additions and 29 deletions

View File

@ -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]()**

View File

@ -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
View 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
-
-

View File

@ -4,4 +4,3 @@ This directory contains documentation for contributors.
- [Repository and Project Structure](./repo) - [Repository and Project Structure](./repo)
- [Design](./design) - [Design](./design)
- [Installation](./installation)

View File

@ -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
-
-