diff --git a/app/modules/keypair/index.ts b/app/modules/keypair/index.ts index 21f88e9ad1c6cec52e3bbe3317fcf8e3180b4937..a809f75fd2b2af3d665f6fa4443f7ad5a119748c 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 0465553fbe95f43467e06378ef1e8954d0fd0bac..b3e0670478554d4e997677cc8846ba40582e3585 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 node gyp fo compile C/C++ dependencies (sqlite and leveldb) +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 ```