Skip to content

Commit 35e84ef

Browse files
committed
[docs] update dev quick start (#181)
1 parent 17922ac commit 35e84ef

File tree

1 file changed

+24
-18
lines changed

1 file changed

+24
-18
lines changed

docs/core_devs/dev_quick_start.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,17 @@
11
# Libra Dev Quick Start
22
## TL;DR
33

4-
* You need our fork of diem before working on `libra-framework`
5-
```
6-
git clone https://github.com/0LNetworkCommunity/diem -b release --single-branch
4+
* You need our fork of `diem-node` before working on `libra-framework`
5+
* compile `diem-node` to `$HOME/.cargo/bin`
76

87
```
8+
git clone https://github.com/0LNetworkCommunity/diem -b release --single-branch
9+
export RUST_DIEM_COIN_MODULE="libra_coin"
10+
export RUST_DIEM_COIN_NAME="LibraCoin"
11+
cd diem
12+
cargo build --profile cli -p diem-node --target-dir ~/.cargo/bin
913
10-
11-
* compile `diem` and `diem-node` to `$HOME/.cargo/bin`
12-
13-
```
14-
cargo build --profile cli -p diem -p diem-node --target-dir ~/.cargo/bin
15-
# make them executable
16-
chmod +x ~/.cargo/diem
14+
# make it executable
1715
chmod +x ~/.cargo/diem-node
1816
```
1917
* export these env vars in your dev env, `~/.bashrc` or `~/.zshrc`
@@ -36,23 +34,31 @@ git clone https://github.com/0LNetworkCommunity/diem -b release --single-branch
3634
This assumes that you have a `~/.cargo/bin` which is added to your environment's $PATH.
3735

3836
### build executables
39-
You want to create a `diem` executable so you can run the `move` cli with the framework changes.
37+
You want to build the `diem-node` (for smoke tests only).
4038

41-
You'll want `diem` (cli for move tests), `diem-node` (for smoke tests only).
39+
There are two environment variables that are needed to use the correct Coin for
40+
diem-node instead of a generic.
4241

43-
Note that the `--profile cli` compilation profile makes for much smaller binaries (e.g. `diem` goes from about 2GB to 30MB).
42+
`export RUST_DIEM_COIN_MODULE: "libra_coin"`
43+
`export RUST_DIEM_COIN_NAME: "LibraCoin"`
44+
45+
Note that the `--profile cli` compilation profile makes for much smaller binaries (e.g. `diem-node` goes from about 2GB to 30MB).
4446

4547
```
46-
cargo build --profile cli -p diem -p diem-node --target-dir ~/.cargo/bin
47-
# see you tomorrow.
48+
# env variables needed for compilation
49+
export RUST_DIEM_COIN_MODULE="libra_coin"
50+
export RUST_DIEM_COIN_NAME="LibraCoin"
51+
52+
# build it
53+
cargo build --profile cli -p diem-node --target-dir ~/.cargo/bin
54+
# see you tomorrow (welcome to rust).
4855
49-
# next day, make them executable.
50-
chmod +x ~/.cargo/diem
56+
# next day, make it executable.
5157
chmod +x ~/.cargo/diem-node
5258
```
5359

5460
Just check those executables appear in your path.
55-
`which diem`
61+
`which diem-node`
5662

5763
Now you can run commands as below.
5864
## Running Move unit tests

0 commit comments

Comments
 (0)