mirror of
https://github.com/tmrts/go-patterns.git
synced 2025-04-08 19:42:01 +00:00
Add install and build instructions
Add install and build instructions to README for people not familiar with gitbook-cli
This commit is contained in:
parent
f978e42036
commit
1677f96d2a
1 changed files with 17 additions and 0 deletions
17
README.md
17
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
|
||||
```
|
||||
|
|
Loading…
Add table
Reference in a new issue