Core/grin
0
0
Fork 0
mirror of https://github.com/mimblewimble/grin.git synced 2025-02-08 04:11:08 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated docs (#1418)

Browse source 
Updated docs to reflect new dependencies
This commit is contained in:
JackRack 2018-08-29 19:09:53 +01:00 committed by Ignotus Peverell
parent e5d43fee44
commit 436e68d6e0
1 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/build.md
View file

@ -19,6 +19,8 @@ What's working so far?
- pkc-config - pkc-config
- libssl-dev - libssl-dev
- linux-headers (reported needed on Alpine linux) - linux-headers (reported needed on Alpine linux)
- pkg-config (reported on Ubuntu)
- libssl-dev (reported on various builds)
## Build steps ## Build steps
@ -27,8 +29,7 @@ git clone https://github.com/mimblewimble/grin.git
cd grin cd grin
cargo build --release cargo build --release
``` ```
Grin can also be built in debug mode (without the `--release` flag, but using the `--debug` or the `--verbose` flag) but this will render fast sync prohibitively slow due to the large overhead of cryptographic operations.
Grin can also be built in debug mode (without the `--release` flag) but this will render fast sync prohibitively slow due to the large overhead of cryptographic operations.
## Mining in Grin ## Mining in Grin
@ -58,6 +59,7 @@ While testing, put the grin binary on your path like this:
``` ```
export PATH=/path/to/grin/dir/target/debug:$PATH export PATH=/path/to/grin/dir/target/debug:$PATH
``` ```
Where path/to/grin/dir is your absolute path to the root directory of your Grin installation.
You can then run `grin` directly (try `grin help` for more options). You can then run `grin` directly (try `grin help` for more options).