From 1677f96d2a353432d5e6ecc7e7f731bbe580eda9 Mon Sep 17 00:00:00 2001 From: Przemyslaw Hugh Kaznowski Date: Fri, 22 Nov 2019 20:54:18 +0000 Subject: [PATCH] Add install and build instructions Add install and build instructions to README for people not familiar with gitbook-cli --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 7d9f5f7..a553be8 100644 --- a/README.md +++ b/README.md @@ -108,3 +108,20 @@ A curated collection of idiomatic design & application patterns for Go language. | Pattern | Description | Status | |:-------:|:----------- |:------:| | [Cascading Failures](/anti-patterns/cascading_failures.md) | A failure in a system of interconnected parts in which the failure of a part causes a domino effect | ✘ | + +## Installation + +To install, you will need gitbook. + +```sh +npm install -g gitbook-cli +``` + +Then you can build either html or pdf like so + +```sh +# HTML +gitbook build +# PDF +gitbook pdf +```