diff --git a/README.md b/README.md index dad66715d8882a1536525b1347248e5acc4c0814..23a2803ace467e2a5acf4bd2b3dd93339dacab71 100644 --- a/README.md +++ b/README.md @@ -103,7 +103,7 @@ docker run -it -p9944:9944 --name duniter-v2s \ ## Contribute -If you are beginner in Rust and need a well guided tutorial, follow the [beginner walkthrough](./docs/dev/beginner-walkthrough.md) +If you are beginner in Rust and need a well guided tutorial, follow the [beginner walkthrough](./docs/dev/beginner-walkthrough.md). Before any contribution, please read carefully the [CONTRIBUTING](./CONTRIBUTING.md) file and our [git conventions](./docs/dev/git-conventions.md). diff --git a/docs/dev/beginner-walkthrough.md b/docs/dev/beginner-walkthrough.md index 9dc2a944cd8039ac57865d3e3994bbbd27fac2be..ad47ff391b4f8dbde7688958e852c444b9d98873 100644 --- a/docs/dev/beginner-walkthrough.md +++ b/docs/dev/beginner-walkthrough.md @@ -1,8 +1,8 @@ # Beginner walkthrough -This is a beginner tutorial for those who do not have a previous experience with Rust ecosystem or need guidance to get familiar with Duniter v2s project. You'll need a development machine with an internet connexion, at least 20 Go of free storage, and an hour or two depending on your computing power. +This is a beginner tutorial for those who do not have a previous experience with Rust ecosystem or need guidance to get familiar with Duniter v2s project. You'll need a development machine with an internet connection, at least **20 Go of free storage**, and **an hour or two** depending on your computing power. -This walkthrough is based on the following video (french), don't hesitate to make an english voicecover if you feel so. +This walkthrough is based on the following video (french), don't hesitate to record an english voicecover if you feel so. [](https://tube.p2p.legal/w/n4TXxQ4SqxzpHPY4TNMXFu) @@ -10,7 +10,7 @@ This walkthrough is based on the following video (french), don't hesitate to mak ## Requirements -If you are a debian based system, you can install the system requirements with: +If you are on a debian based system, you can install the required packages with: ```bash sudo apt install cmake pkg-config libssl-dev git build-essential clang libclang-dev curl @@ -33,7 +33,7 @@ rustup update stable rustup target add wasm32-unknown-unknown --toolchain nightly ``` -This can take about one or two minutes. +This can take about **2 minutes**. ## Build project @@ -49,13 +49,13 @@ you can go to the root folder and build the substrate client with: cargo build ``` -This will take about 2 minutes to download dependencies and 12 minutes to build in debug mode. At this point, you only built the substrate client, a kind of "shell" in which lies the runtime. You can build the runtime and run a local blockchain with: +This will take about **2 minutes** to download dependencies and **12 minutes** to build in debug mode. At this point, you only built the substrate client, a kind of "shell" in which lies the runtime. You can build the runtime and run a local blockchain with: ```bash cargo run -- --dev --tmp ``` -Which should take about 1 minute. When you see the logs, the blockchain is running and you can connect to it with polkadotjs app: [https://polkadot.js.org/apps/?rpc=ws://127.0.0.1:9944](https://polkadot.js.org/apps/?rpc=ws%3A%2F%2F127.0.0.1%3A9944). You should see blocks being added every 6 seconds. You can use Alice, Bob, etc test accounts to submit extrinsics. +Which should take about **1 minute**. When you see the logs, the blockchain is running and you can connect to it with polkadotjs app: [https://polkadot.js.org/apps/?rpc=ws://127.0.0.1:9944](https://polkadot.js.org/apps/?rpc=ws%3A%2F%2F127.0.0.1%3A9944). You should see blocks being added every 6 seconds. You can use Alice, Bob, etc test accounts to submit extrinsics. ## Autocompletion @@ -70,9 +70,9 @@ cargo run --release -- completion --generator bash > ~/.local/share/duniter/comp [[ -f $HOME/.local/share/duniter/completion.bash ]] && source $HOME/.local/share/duniter/completion.bash ``` -Building in release mode for the first time is very long and can take up to 20 minutes. You will then benefit from completion using `<Tab>` key and `*`. +Building in release mode for the first time is very long and can take up to **20 minutes**. You will then benefit from completion using `<Tab>` key and `*`. -## End to end tests using cucumber +## End-to-end tests using cucumber Cucumber end2end tests are a good way to dive in Duniter's business procedure. They work by spawning a local blockchain and submitting extrinsics to it. You can build and run the cucumber tests by running: @@ -80,4 +80,8 @@ Cucumber end2end tests are a good way to dive in Duniter's business procedure. T cargo cucumber ``` -which should take about 4 minutes to build and run the tests. A highly detailed documentation about the end2end tests is available [in the dedicated folder](../../end2end-tests/README.md), you will learn how to read and modify the tests. \ No newline at end of file +which should take about **4 minutes** to build and run the tests. A highly detailed documentation about the end2end tests is available [in the dedicated folder](../../end2end-tests/README.md), you will learn how to read and modify the tests. + +## Get in tuch with us + +Wether you are stuck and need help or have sucessfully completed this tutorial, don't hesitate to get in touch with us on the Duniter forum! If you found this walkthrough useful, please 🙠let us know on the [walkthrough topic](https://forum.duniter.org/t/contribuer-a-duniter-tutoriel-video/9770) on the forum 😊. \ No newline at end of file