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

Updated build instructions for T3

Browse source
This commit is contained in:
Ignotus Peverell 2018-07-08 20:22:12 +01:00
parent 6fea0ba91f
commit e397ea2d91
No known key found for this signature in database
GPG key ID: 99CD25F39F8F8211
1 changed files with 16 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
doc/build.md
View file

@ -15,34 +15,19 @@ Please note that all mining functions for Grin have moved into a separate, stand
[grin_miner](https://github.com/mimblewimble/grin-miner). Once your Grin code node is up and running, [grin_miner](https://github.com/mimblewimble/grin-miner). Once your Grin code node is up and running,
you can start mining by building and running grin-miner against your running Grin node. you can start mining by building and running grin-miner against your running Grin node.
## Docker
# Build using all available cores
docker build -t grin .
# run in foreground
docker run -it -v grin:/usr/src/grin grin
# or in background
docker run -it -d -v grin:/usr/src/grin grin
If you decide to use a persistent storage (e.g. ```-v grin:/usr/src/grin```) you will need grin.toml configuration file in it.
## Requirements ## Requirements
- rust 1.24+ (use [rustup]((https://www.rustup.rs/))- i.e. `curl https://sh.rustup.rs -sSf | sh; source $HOME/.cargo/env`) - rust 1.26+ (use [rustup]((https://www.rustup.rs/))- i.e. `curl https://sh.rustup.rs -sSf | sh; source $HOME/.cargo/env`)
- rocksdb + libs for compiling rocksdb: - clang (clanglib or clang-devel or libclang-dev)
- clang (clanglib or clang-devel or libclang-dev)
- llvm (Fedora llvm-devel, Debian llvm-dev)
- ncurses and libs (ncurses, ncursesw5) - ncurses and libs (ncurses, ncursesw5)
- zlib libs (zlib1g-dev or zlib-devel) - zlib libs (zlib1g-dev or zlib-devel)
- linux-headers (reported needed on Alpine linux) - linux-headers (reported needed on Alpine linux)
## Build steps ## Build steps
```sh ```sh
git clone https://github.com/mimblewimble/grin.git git clone https://github.com/mimblewimble/grin.git
git checkout milestone/testnet3
cd grin cd grin
cargo build --release cargo build --release
``` ```
@ -86,6 +71,19 @@ You can then run `grin` directly (try `grin help` for more options).
manually isn't required anymore. Grin will create a seed file and run the manually isn't required anymore. Grin will create a seed file and run the
listener automatically on start. listener automatically on start.
## Docker
# Build using all available cores
docker build -t grin .
# run in foreground
docker run -it -v grin:/usr/src/grin grin
# or in background
docker run -it -d -v grin:/usr/src/grin grin
If you decide to use a persistent storage (e.g. ```-v grin:/usr/src/grin```) you will need grin.toml configuration file in it.
# Configuration # Configuration
Grin attempts to run with sensible defaults, and can be further configured via Grin attempts to run with sensible defaults, and can be further configured via