From 1a5d24bd6f6fb7001fb2a6a5fe281ed2a92db6d1 Mon Sep 17 00:00:00 2001 From: Lukas Lukac Date: Sat, 18 Apr 2020 11:52:07 +0200 Subject: [PATCH] Updates Readme with repository installation instructions. --- Readme.md | 47 ++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 42 insertions(+), 5 deletions(-) diff --git a/Readme.md b/Readme.md index 318fc9a..5650da8 100644 --- a/Readme.md +++ b/Readme.md @@ -1,19 +1,21 @@ # The Blockchain Bar > Build a custom blockchain in Go from scratch. -The full source-code for book: "The Blockchain Way of Programming". +The source-code for the first 6 chapters of: "The Blockchain Way of Programming". -https://web3.coach +Download the eBook from: https://web3.coach ## Foreword Welcome to the blockchain world! -Thank you for your trust and purchase of the full eBook version. You made the right choice of learning blockchain development and expanding your programming career. +You made the right choice of learning blockchain development and expanding your programming career. -Enjoy the ride :) +**This repository is just an extract from the private Github repository and it contains roughly 5-10% of the overall full source code that you will get access to after purchasing the complete eBook once it's ready in a few weeks time.** + +Enjoy your blockchain programming journey! ## How to use this repository -Every chapter has a dedicated branch where you can experiment with the code first-hand. +Every eBook chapter has a dedicated branch where you can experiment with the code first-hand. ```git git branch @@ -25,6 +27,39 @@ git branch > c5... ``` +## Installation + +### Install Go +Follow the official docs or use your favorite dependency manager +to install Go: [https://golang.org/doc/install](https://golang.org/doc/install) + +Verify your `$GOPATH` is correctly set before continuing. + +### Setup this Repository + +Go is bit picky about where you store your repositories. + +The convention is to store: +- the source code inside the `$GOPATH/src` +- the compiled program binaries inside the `$GOPATH/bin` + +You can `clone` the repository or use `go get` to install it. + +#### Using Git +```bash +mkdir -p $GOPATH/src/github.com/web3coach +cd $GOPATH/src/github.com/web3coach + +git clone git@github.com:web3coach/the-blockchain-way-of-programming-newsletter-edition.git +``` + +PS: Make sure you actually clone it inside the `src/github.com/web3coach` directory, not your own, otherwise it won't compile. Go rules. + +#### Using Go Get +```bash +go get -u github.com/web3coach/the-blockchain-way-of-programming-newsletter-edition +``` + ## Getting Started 1. Open the eBook at Chapter 1 1. Checkout the first chapter's branch @@ -37,6 +72,8 @@ Read, experiment with the code and, most importantly, have fun! ## Getting Unstuck Can't understand why is something done in a particular way or crack your way around a specific chapter's topic? + +Blockchain is a challenging technology. As I promised, you have my full support. You are not alone in this. Write me a DM on LinkedIn, and I will help you figure it out and move forward on your new journey :)