From ef487a35b0febabc2256ff9c028b63c42509686d Mon Sep 17 00:00:00 2001 From: dome Date: Mon, 12 Dec 2022 23:32:44 +0700 Subject: [PATCH] add Installing Documentation (#384) --- docs/README.md | 3 ++- docs/installation/README.md | 26 ++++++++++++++++++++++++++ 2 files changed, 28 insertions(+), 1 deletion(-) create mode 100644 docs/installation/README.md diff --git a/docs/README.md b/docs/README.md index 427690dfd..679bcb130 100644 --- a/docs/README.md +++ b/docs/README.md @@ -3,4 +3,5 @@ This directory contains documentation for contributors. - [Repository and Project Structure](./repo) -- [Design](./design) \ No newline at end of file +- [Design](./design) +- [Installation](./installation) \ No newline at end of file diff --git a/docs/installation/README.md b/docs/installation/README.md new file mode 100644 index 000000000..329f2fdee --- /dev/null +++ b/docs/installation/README.md @@ -0,0 +1,26 @@ +## 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