diff --git a/README.md b/README.md index 816c5eb4db2fe02341cfb357755e63d983934423..4fc573ab803be8bb077d2a04b493da0896aa9434 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,30 @@ -# 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`: + + + ### Multi-Node Local Testnet If you want to see the multi-node consensus algorithm in action, refer to diff --git a/docs/rust-setup.md b/docs/setup.md similarity index 97% rename from docs/rust-setup.md rename to docs/setup.md index 34f6e43e7f0dd12bb63d115595217f3b767c9b21..3a61968a8326c93c4c1eae1828c1f496f9070fc1 100644 --- a/docs/rust-setup.md +++ b/docs/setup.md @@ -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 diff --git a/images/js-app-custom-types.png b/images/js-app-custom-types.png new file mode 100644 index 0000000000000000000000000000000000000000..3a181d39ad47fb8c116ba4d75410951d97f53ef4 Binary files /dev/null and b/images/js-app-custom-types.png differ