From 4c298ac02275bb2ff51831c386b75a66f10980ce Mon Sep 17 00:00:00 2001 From: Satoshi Okamoto <107277499+butcher73@users.noreply.github.com> Date: Thu, 15 Dec 2022 18:55:59 +0700 Subject: [PATCH] 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 --- book/README.md | 1 + book/SUMMARY.md | 2 +- book/installation.md | 68 +++++++++++++++++++++++++++++++++++++ docs/README.md | 3 +- docs/installation/README.md | 26 -------------- 5 files changed, 71 insertions(+), 29 deletions(-) create mode 100644 book/installation.md delete mode 100644 docs/installation/README.md diff --git a/book/README.md b/book/README.md index 1c2c371a2..46f028f3c 100644 --- a/book/README.md +++ b/book/README.md @@ -15,6 +15,7 @@ The book is continuously rendered [here](https://paradigmxyz.github.io/reth/)! **[Getting Started]()** 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]()** diff --git a/book/SUMMARY.md b/book/SUMMARY.md index a28b07437..c0d84e433 100644 --- a/book/SUMMARY.md +++ b/book/SUMMARY.md @@ -2,7 +2,7 @@ # Getting Started -- [Installation]() +- [Installation](./installation.md) - [First Steps with Reth]() - [Configuring The Node]() diff --git a/book/installation.md b/book/installation.md new file mode 100644 index 000000000..2f7b29823 --- /dev/null +++ b/book/installation.md @@ -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 +- +- \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index 679bcb130..427690dfd 100644 --- a/docs/README.md +++ b/docs/README.md @@ -3,5 +3,4 @@ This directory contains documentation for contributors. - [Repository and Project Structure](./repo) -- [Design](./design) -- [Installation](./installation) \ No newline at end of file +- [Design](./design) \ No newline at end of file diff --git a/docs/installation/README.md b/docs/installation/README.md deleted file mode 100644 index 329f2fdee..000000000 --- a/docs/installation/README.md +++ /dev/null @@ -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 - - - - \ No newline at end of file