Update readme and rust setup instructions

xx-labs · Feb 20, 2023 · 4504e15 · 4504e15
1 parent 2ee5c97
commit 4504e15
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -4,6 +4,17 @@
 
 First, complete the [basic Rust setup instructions](./doc/rust-setup.md).
 
+### Build
+
+Recommended OS to build the `xxnetwork-chain` binary is Ubuntu 20 or above.
+The makefile provides build commands, of which the most important are:
+
+```sh
+make build-prod         # Build production ready node binary
+make build-release      # Build release node binary
+make build              # Build all packages
+```
+
 ### MacOS users: setup to compile for Linux
 
 Before being able to build for linux on macOS, the following extra steps are needed:
@@ -14,14 +25,7 @@ brew tap SergioBenitez/osxct               # Tap this project with brew
 brew install x86_64-unknown-linux-gnu      # Install cross-compile tools for GNU
 ```
 
-### Build
-
-The makefile provides build commands, of which the most important are:
-
-```sh
-make build                # Build node binary for current OS
-make build-linux-from-mac # Build node binary for Linux from macOS
-```
+Then, the target for the rust compiler needs to be specified on any build command with `--target=x86_64-unknown-linux-gnu`.
 
 ### Test
 
@@ -49,6 +53,6 @@ sh ./scripts/benchmark.sh
 
 ### Code Review
 
-A code review was performed by ChainSafe. It focused mostly on the modification to the Staking pallet
+A code review was performed by ChainSafe. It focused mostly on the modifications to the Staking pallet
 and the custom made xx network pallets for cmix, economics and team custody.
 The report can be found [here](./doc/ChainSafe%20xxchain%20Code%20Review.pdf).
diff --git a/doc/rust-setup.md b/doc/rust-setup.md
@@ -35,7 +35,7 @@ Use a terminal shell to execute the following commands:
 ```bash
 sudo apt update
 # May prompt for location information
-sudo apt install -y cmake pkg-config libssl-dev git build-essential clang libclang-dev curl
+sudo apt install -y cmake pkg-config libssl-dev git build-essential clang libclang-dev curl protobuf-compiler
 ```
 
 ### Arch Linux
@@ -56,7 +56,7 @@ Use a terminal to run the following commands:
 # Update
 sudo dnf update
 # Install packages
-sudo dnf install cmake pkgconfig rocksdb rocksdb-devel llvm git libcurl libcurl-devel curl-devel clang
+sudo dnf install cmake pkgconfig rocksdb rocksdb-devel llvm git libcurl libcurl-devel curl-devel clang protobuf-compiler
 ```
 
 ## Rust Developer Environment