Skip to content

Commit 61b1006

Browse files
committedJul 14, 2021
doc: improve README
1 parent 8eaa357 commit 61b1006

File tree

3 files changed

+18
-12
lines changed

3 files changed

+18
-12
lines changed
 

‎README.md

+17-11
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,30 @@
1-
# Substrate Node Template
1+
# Libre currency based on Substrate framework
22

3-
A fresh FRAME-based [Substrate](https://www.substrate.io/) node, ready for hacking :rocket:
3+
A FRAME-based [Substrate](https://www.substrate.io/) libre currency implementation.
44

5-
### Rust Setup
5+
## Setup
66

7-
First, complete the [basic Rust setup instructions](./docs/rust-setup.md).
7+
First, complete the [basic setup instructions](./docs/setup.md).
88

9-
### Run
9+
## Build
1010

11-
Use Rust's native `cargo` command to build and launch the template node:
11+
NOTE: You must first follow the instructions in the [Setup] section (#setup).
12+
13+
Use the following command to build the node without launching it:
1214

1315
```sh
14-
cargo run --release -- --dev --tmp
16+
cargo build --release
1517
```
1618

17-
### Build
19+
## Run
1820

19-
The `cargo run` command will perform an initial build. Use the following command to build the node
20-
without launching it:
21+
Use Rust's native `cargo` command to build and launch the node:
2122

2223
```sh
23-
cargo build --release
24+
cargo run --release -- --dev --tmp
2425
```
2526

27+
2628
### Embedded Docs
2729

2830
Once the project has been built, the following command can be used to explore all parameters and
@@ -63,6 +65,10 @@ RUST_LOG=debug RUST_BACKTRACE=1 ./target/release/lc-core -lruntime=debug --dev
6365
Once the node template is running locally, you can connect it with **Polkadot-JS Apps** front-end
6466
to interact with your chain. [Click here](https://polkadot.js.org/apps/#/explorer?rpc=ws://localhost:9944) connecting the Apps to your local node template.
6567

68+
CAUTION: Pour que **Polkadot-JS Apps** soit capable de comprendre pleinement l'interface exposée par le noeud, vous devez y importer les types définies dans le fichier `types-bundle/types_definition.json`:
69+
70+
![js-app-custom-types](./images/js-app-custom-types.png)
71+
6672
### Multi-Node Local Testnet
6773

6874
If you want to see the multi-node consensus algorithm in action, refer to

‎docs/rust-setup.md ‎docs/setup.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Installation
33
---
44

55
This page will guide you through the steps needed to prepare a computer for development with the
6-
Substrate Node Template. Since Substrate is built with
6+
Substrate Node. Since Substrate is built with
77
[the Rust programming language](https://www.rust-lang.org/), the first thing you will need to do is
88
prepare the computer for Rust development - these steps will vary based on the computer's operating
99
system. Once Rust is configured, you will use its toolchains to interact with Rust projects; the

‎images/js-app-custom-types.png

102 KB
Loading

0 commit comments

Comments
 (0)
Please sign in to comment.