absolutebi/serai
1
0
Fork 0
mirror of https://github.com/serai-dex/serai.git synced 2025-12-08 12:19:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Lint Getting Started document

Browse Source
This commit is contained in:
Luke Parker
2022-08-21 00:45:41 -04:00
parent 74e2d230e8
commit f319966dca
1 changed files with 34 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
docs/Getting Started.md
View File

@@ -1,59 +1,67 @@
# Getting Started # Getting Started
## Clone Serai ### System Dependencies
##### Ubuntu
``` ```
git clone https://github.com/serai-dex/serai.git sudo apt-get install -y build-essential cmake clang-11 git curl python3-pip
``` ```
## Build and Run Serai ### Install rustup
### Install Rust ##### Linux
#### Linux
``` ```
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
``` ```
#### Windows ##### macOS
Use WSL2 and Linux instructions.
#### Mac
``` ```
brew install rustup brew install rustup
``` ```
### Install Solidity Compiler ### Install Rust
```
rustup update
rustup toolchain install nightly
rustup target add wasm32-unknown-unknown --toolchain nightly
```
### Install Solidity
``` ```
sudo pip3 install solc-select sudo pip3 install solc-select
solc-select install 0.8.16 solc-select install 0.8.16
solc-select use 0.8.16 solc-select use 0.8.16
``` ```
### Install Other Dependencies
### Install foundry and anvil (for tests)
``` ```
sudo apt-get install -y \ cargo install --git https://github.com/foundry-rs/foundry --profile local --locked foundry-cli anvil
cmake \
libboost-all-dev \
pkg-config \
libssl-dev
``` ```
### Build ### Clone and Build Serai
``` ```
git clone https://github.com/serai-dex/serai
cd serai cd serai
cargo build --release cargo build --release
``` ```
### Run ### Run Tests
Running tests requires a Monero regtest node running in the background.
``` ```
./target/release/serai-node --chain dev cargo test --all-features
OR
./target/release/serai-node --dev
``` ```
### Help ### Run Serai in Development Mode
``` ```
./target/release/serai-node --help ./target/release/serai-node --dev
``` ```