Ecosystem/serai
Ecosystem/serai
1
0
Fork 0
mirror of https://github.com/serai-dex/serai.git synced 2024-09-29 01:41:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Simple getting started doc (#91)

Browse source 
* simple getting started doc

* Swap Old Ubuntu and Solc

* Fixes indents and removes OS preferences

* drops indents from code blocks
This commit is contained in:
TheArchitect108 2022-08-20 23:26:16 -05:00 committed by GitHub
parent c53e7ad6c7
commit 74e2d230e8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 59 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
docs/Getting Started.md Normal file
View file

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