From e24c1ab5877e8d17b630af0e621a2a7be3eaa6d4 Mon Sep 17 00:00:00 2001 From: Nemo Date: Tue, 19 Jan 2021 14:31:26 +0530 Subject: [PATCH] [docs] Add Linux/Mac instructions for both books --- COPYING | 2 +- README.md | 16 ++++++++++++---- 2 files changed, 13 insertions(+), 5 deletions(-) diff --git a/COPYING b/COPYING index 56fce5e..263f6ba 100644 --- a/COPYING +++ b/COPYING @@ -1,7 +1,7 @@ DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE Version 2, December 2004 - Copyright (C) 2015 Abhay Rana + Copyright (C) 2021 Abhay Rana Everyone is permitted to copy and distribute verbatim or modified copies of this license document, and changing it is allowed as long diff --git a/README.md b/README.md index 0d5a1ae..4d14c0a 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Generates a EPUB/MOBI/PDF for the Google SRE Book/s. Original sources are downloaded from https://landing.google.com/sre/books -Visit the [Releases](https://github.com/captn3m0/google-sre-ebook/releases) page to download the latest release. +Visit the [Releases](https://github.com/captn3m0/google-sre-ebook/releases) page to download the latest release. Go through all the releases, and click "Assets" to view a list of files. # Books @@ -44,9 +44,7 @@ $ docker run --rm --volume "/tmp/sreoutput:/output" -e BOOK_SLUG='srw_book' capt The build for the above Docker image can be audited at . -## macOS - -Review and run the `generate.sh` script to generate the EPUB, MOBI, and PDF files +## macOS / Linux Requirements: @@ -57,6 +55,16 @@ Requirements: - `brew cask install calibre` - `brew install wget` +Run either of the following: + +```bash +# To download Site Reliability Engineering. +BOOK_SLUG='sre_book' ./generate.sh + +# To download The Site Reliability Workbook. +BOOK_SLUG='srw_book' ./generate.sh +``` + # Known Issues - metadata is not complete. There are just too many authors