Mise à jour de GitLab prévue ce samedi 23 octobre 2021 à partir de 9h00 CET

Commit 61b1006e authored by Éloïs's avatar Éloïs
Browse files

doc: improve README

parent 8eaa3572
# Substrate Node Template
# Libre currency based on Substrate framework
A fresh FRAME-based [Substrate](https://www.substrate.io/) node, ready for hacking :rocket:
A FRAME-based [Substrate](https://www.substrate.io/) libre currency implementation.
### Rust Setup
## Setup
First, complete the [basic Rust setup instructions](./docs/rust-setup.md).
First, complete the [basic setup instructions](./docs/setup.md).
### Run
## Build
Use Rust's native `cargo` command to build and launch the template node:
NOTE: You must first follow the instructions in the [Setup] section (#setup).
Use the following command to build the node without launching it:
```sh
cargo run --release -- --dev --tmp
cargo build --release
```
### Build
## Run
The `cargo run` command will perform an initial build. Use the following command to build the node
without launching it:
Use Rust's native `cargo` command to build and launch the node:
```sh
cargo build --release
cargo run --release -- --dev --tmp
```
### Embedded Docs
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
Once the node template is running locally, you can connect it with **Polkadot-JS Apps** front-end
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.
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`:
![js-app-custom-types](./images/js-app-custom-types.png)
### Multi-Node Local Testnet
If you want to see the multi-node consensus algorithm in action, refer to
......
......@@ -3,7 +3,7 @@ title: Installation
---
This page will guide you through the steps needed to prepare a computer for development with the
Substrate Node Template. Since Substrate is built with
Substrate Node. Since Substrate is built with
[the Rust programming language](https://www.rust-lang.org/), the first thing you will need to do is
prepare the computer for Rust development - these steps will vary based on the computer's operating
system. Once Rust is configured, you will use its toolchains to interact with Rust projects; the
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment