From f8aaec0eea3571aadca659f890502cf198918b59 Mon Sep 17 00:00:00 2001 From: ian Date: Wed, 10 Apr 2019 11:20:49 +0800 Subject: [PATCH] docs: ckb is available via github releases now --- README.md | 2 +- docs/{build.md => get-ckb.md} | 14 +++++++++++--- 2 files changed, 12 insertions(+), 4 deletions(-) rename docs/{build.md => get-ckb.md} (78%) diff --git a/README.md b/README.md index bc79558860..bbfdf22bd6 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ The contribution workflow is described in [CONTRIBUTING.md](CONTRIBUTING.md), an ## Documentations -- [Build CKB](docs/build.md) +- [Get CKB](docs/get-ckb.md) - [Quick Start](docs/quick-start.md) - [Configure CKB](docs/configure.md) - [CKB Core Development](docs/ckb-core-dev.md) diff --git a/docs/build.md b/docs/get-ckb.md similarity index 78% rename from docs/build.md rename to docs/get-ckb.md index 2049440fdf..0ff74ae7a5 100644 --- a/docs/build.md +++ b/docs/get-ckb.md @@ -1,6 +1,14 @@ -# Build CKB +# Get CKB -## Install Build Dependencies +## Download from Releases + +We will publish binaries for each release via [Github Releases](https://github.com/nervosnetwork/ckb/releases). If your system +is listed there, you can download the package directory. + + +## Build from Source + +### Install Build Dependencies CKB is currently tested mainly with `stable-1.33.0` on Linux and macOS. @@ -33,7 +41,7 @@ sudo pacman -Sy git gcc pkgconf clang brew install autoconf libtool ``` -## Build from Source +### Build ```bash # get ckb source code