From 74e2d230e86f741008c994482051a330e5193e4e Mon Sep 17 00:00:00 2001 From: TheArchitect108 <75815740+TheArchitect108@users.noreply.github.com> Date: Sat, 20 Aug 2022 23:26:16 -0500 Subject: [PATCH] Simple getting started doc (#91) * simple getting started doc * Swap Old Ubuntu and Solc * Fixes indents and removes OS preferences * drops indents from code blocks --- docs/Getting Started.md | 59 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 docs/Getting Started.md diff --git a/docs/Getting Started.md b/docs/Getting Started.md new file mode 100644 index 00000000..2a37f661 --- /dev/null +++ b/docs/Getting Started.md @@ -0,0 +1,59 @@ +# Getting Started + +## Clone Serai +``` +git clone https://github.com/serai-dex/serai.git +``` + +## Build and Run Serai + +### Install Rust + +#### Linux +``` +curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh +``` + +#### Windows + +Use WSL2 and Linux instructions. + + +#### Mac + +``` +brew install rustup +``` + +### Install Solidity Compiler +``` +sudo pip3 install solc-select +solc-select install 0.8.16 +solc-select use 0.8.16 +``` +### Install Other Dependencies +``` +sudo apt-get install -y \ +cmake \ +libboost-all-dev \ +pkg-config \ +libssl-dev +``` + +### Build +``` +cd serai +cargo build --release +``` + +### Run +``` +./target/release/serai-node --chain dev +OR +./target/release/serai-node --dev +``` + +### Help +``` +./target/release/serai-node --help +``` \ No newline at end of file