From 02ad8bbf6e70d9513731cf79bb477e275b2899a0 Mon Sep 17 00:00:00 2001
From: tykayn <tykayn@gmail.com>
Date: Mon, 6 Apr 2020 17:06:03 +0200
Subject: [PATCH 1/2] [feat] :book: doc to setup rust cargo, and rearrange yarn
install
---
doc/quick-start.md | 11 ++++++++++-
1 file changed, 10 insertions(+), 1 deletion(-)
diff --git a/doc/quick-start.md b/doc/quick-start.md
index 0465553fb..cd56df5c7 100644
--- a/doc/quick-start.md
+++ b/doc/quick-start.md
@@ -7,7 +7,15 @@
- [yarn](https://classic.yarnpkg.com/en/docs/install/)
- [python 2.7](https://www.python.org/downloads/) (Linux? -> you allready have it)
- [gcc](https://github.com/nodejs/node-gyp#installation)
+```bash
+# install cargo for rust
+npm i -g node-gyp
+```
- [rust](https://www.rust-lang.org/learn/get-started)
+```bash
+# install cargo for rust
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+```
- [Gitlab](https://git.duniter.org/) account (optional, needed to contribute)
## Install
@@ -15,8 +23,9 @@
```bash
git clone https://git.duniter.org/nodes/typescript/duniter.git
cd duniter
-yarn
+rustup update
yarn add duniter-ui
+yarn
bin/duniter webstart
```
--
GitLab
From c60333d19a8b212384de5264507383b726f81212 Mon Sep 17 00:00:00 2001
From: Baptiste Lemoine <contact@cipherbliss.com>
Date: Mon, 6 Apr 2020 17:33:02 +0200
Subject: [PATCH 2/2] [docs] :book: fix documentation on Scrypt parameters
---
app/modules/keypair/index.ts | 8 +++++---
doc/quick-start.md | 2 +-
2 files changed, 6 insertions(+), 4 deletions(-)
diff --git a/app/modules/keypair/index.ts b/app/modules/keypair/index.ts
index 21f88e9ad..a809f75fd 100644
--- a/app/modules/keypair/index.ts
+++ b/app/modules/keypair/index.ts
@@ -34,17 +34,19 @@ export const KeypairDependency = {
},
{
value: "--keyN <N>",
- desc: "Scrypt `N` parameter. Defaults to 4096.",
+ desc:
+ "Scrypt `N` CPU/memory cost parameter. Must be a power of 2. Defaults to 4096.",
parser: parseInt,
},
{
value: "--keyr <r>",
- desc: "Scrypt `N` parameter. Defaults to 16.",
+ desc:
+ "Scrypt `r` The blocksize parameter, which fine-tunes sequential memory read size and performance. Defaults to 16.",
parser: parseInt,
},
{
value: "--keyp <p>",
- desc: "Scrypt `N` parameter. Defaults to 1.",
+ desc: "Scrypt `p` Parallelization parameter. Defaults to 1.",
parser: parseInt,
},
{
diff --git a/doc/quick-start.md b/doc/quick-start.md
index cd56df5c7..b3e067047 100644
--- a/doc/quick-start.md
+++ b/doc/quick-start.md
@@ -8,7 +8,7 @@
- [python 2.7](https://www.python.org/downloads/) (Linux? -> you allready have it)
- [gcc](https://github.com/nodejs/node-gyp#installation)
```bash
-# install cargo for rust
+# install node gyp fo compile C/C++ dependencies (sqlite and leveldb)
npm i -g node-gyp
```
- [rust](https://www.rust-lang.org/learn/get-started)
--
GitLab