|
@@ -26,9 +26,11 @@ The following dependencies are also required:
|
|
|
|
|
|
|
|
Users of Debian-based systems (e.g. Ubuntu) can simply run the following
|
|
Users of Debian-based systems (e.g. Ubuntu) can simply run the following
|
|
|
to install the required dependencies:
|
|
to install the required dependencies:
|
|
|
|
|
+
|
|
|
```shell
|
|
```shell
|
|
|
% sudo apt-get update
|
|
% sudo apt-get update
|
|
|
-% sudo apt-get install -y build-essential clang libclang-dev llvm-dev libudev-dev pkg-config
|
|
|
|
|
|
|
+% sudo apt-get install -y build-essential clang libclang-dev llvm-dev \
|
|
|
|
|
+ libudev-dev pkg-config wget
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
To build the necessary binaries, we can just clone the repo, and use the
|
|
To build the necessary binaries, we can just clone the repo, and use the
|
|
@@ -40,6 +42,13 @@ setup params, and compile the source code.
|
|
|
% make
|
|
% make
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
|
|
+## Development
|
|
|
|
|
+
|
|
|
|
|
+If you want to hack on the source code, make sure to read some
|
|
|
|
|
+introductory advice in the
|
|
|
|
|
+[DarkFi book](https://darkrenaissance.github.io/darkfi/development.html).
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
## Install
|
|
## Install
|
|
|
|
|
|
|
|
This will install the binaries and configurations in the configured
|
|
This will install the binaries and configurations in the configured
|
|
@@ -58,7 +67,7 @@ the testnet if you're following this document.
|
|
|
## Bash Completion
|
|
## Bash Completion
|
|
|
This will add the options auto completion of `drk` and `darkfid`.
|
|
This will add the options auto completion of `drk` and `darkfid`.
|
|
|
```shell
|
|
```shell
|
|
|
-echo source ./auto-complete >> ~/.bashrc
|
|
|
|
|
|
|
+% echo source ./auto-complete >> ~/.bashrc
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
## Usage
|
|
## Usage
|
|
@@ -79,7 +88,6 @@ called `drk`:
|
|
|
|
|
|
|
|
```shell
|
|
```shell
|
|
|
% drk -h
|
|
% drk -h
|
|
|
-drk
|
|
|
|
|
|
|
|
|
|
USAGE:
|
|
USAGE:
|
|
|
drk [FLAGS] [OPTIONS] [SUBCOMMAND]
|
|
drk [FLAGS] [OPTIONS] [SUBCOMMAND]
|
|
@@ -107,14 +115,6 @@ SUBCOMMANDS:
|
|
|
|
|
|
|
|
See the [DarkFi book](https://darkrenaissance.github.io/darkfi)
|
|
See the [DarkFi book](https://darkrenaissance.github.io/darkfi)
|
|
|
|
|
|
|
|
-## Code Formatting
|
|
|
|
|
-
|
|
|
|
|
-```shell
|
|
|
|
|
-cargo +nightly fmt
|
|
|
|
|
-cargo clippy
|
|
|
|
|
-```
|
|
|
|
|
-Try `cargo +nightly clippy --fix --all-features -Z unstable-options` to let clippy autofix some lints.
|
|
|
|
|
-
|
|
|
|
|
## Go Dark
|
|
## Go Dark
|
|
|
|
|
|
|
|
Let's liberate people from the claws of big tech and create the
|
|
Let's liberate people from the claws of big tech and create the
|