From 33aacb166ed9cdb4619b691571efec8f7d7796aa Mon Sep 17 00:00:00 2001 From: Andrew Harmel-Law Date: Fri, 30 Mar 2018 20:34:09 +0100 Subject: [PATCH 1/2] Add note on how to generate a PDF --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f6d7d97..38ea5f5 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,23 @@ This is an Asciidoc book of Simon Wardley's "Wardley Maps". It simply takes all his [medium posts](https://medium.com/wardleymaps) and joins them together for ease of reading. The intention is to be entirely faithful to the original posts - I've not even fixed the few spelling mistakes - while allowing various output versions to be generated, e.g. HTML, and .mobi for Kindle e-readers. It is made available under the same Creative Commons Attribution-ShareAlike-4.0-International licence as the original posts. # Generating the book yourself -To generate the HTML version of this book, you need to have installed [asciidoctor](https://asciidoctor.org/docs/user-manual/), and then you can run the following command in the base directory of this repository: +All these generators require you to have installed [asciidoctor](https://asciidoctor.org/docs/user-manual/). Then select the command you require to generate the output you desire. + +## HTML +To generate the HTML version of this book, run the following command in the base directory of this repository: asciidoctor wardley-maps-book.adoc +## PDF +To generate the PDF version of this book, you additionally need to install [asciidoctor-pdf](https://asciidoctor.cn/docs/convert-asciidoc-to-pdf/) with the following command: + + gem install --pre asciidoctor-pdf + +Then you can run the following command in the base directory of this repository: + + asciidoctor-pdf wardley-maps-book.adoc + +## .Mobi (Kindle) To generate the .mobi version of this book you additionally need to install [Asciidoctor-EPUB3](https://asciidoctor.org/docs/asciidoctor-epub3/) and [kindlegen](https://rubygems.org/gems/kindlegen/versions/3.0.3) both via Ruby gems - the instructions are in the linked pages. The pre-requisite to run both of these is Ruby. You can then run the following command in the base directory of this repository: asciidoctor-epub3 -a ebook-format=kf8 wardley-maps-book.adoc From e62952e5754ee33cd7476298393dbb11d31e97da Mon Sep 17 00:00:00 2001 From: Andrew Harmel-Law Date: Fri, 30 Mar 2018 20:38:28 +0100 Subject: [PATCH 2/2] Add note on forthcoming "Releases" downloads --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 38ea5f5..e02b266 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # Welcome This is an Asciidoc book of Simon Wardley's "Wardley Maps". It simply takes all his [medium posts](https://medium.com/wardleymaps) and joins them together for ease of reading. The intention is to be entirely faithful to the original posts - I've not even fixed the few spelling mistakes - while allowing various output versions to be generated, e.g. HTML, and .mobi for Kindle e-readers. It is made available under the same Creative Commons Attribution-ShareAlike-4.0-International licence as the original posts. +# Downloads +Once I've tested them, there will be downloads of .pdf and .mobi files on the "Releases" tab. + # Generating the book yourself All these generators require you to have installed [asciidoctor](https://asciidoctor.org/docs/user-manual/). Then select the command you require to generate the output you desire. @@ -18,7 +21,7 @@ Then you can run the following command in the base directory of this repository: asciidoctor-pdf wardley-maps-book.adoc -## .Mobi (Kindle) +## .MOBI (Kindle) To generate the .mobi version of this book you additionally need to install [Asciidoctor-EPUB3](https://asciidoctor.org/docs/asciidoctor-epub3/) and [kindlegen](https://rubygems.org/gems/kindlegen/versions/3.0.3) both via Ruby gems - the instructions are in the linked pages. The pre-requisite to run both of these is Ruby. You can then run the following command in the base directory of this repository: asciidoctor-epub3 -a ebook-format=kf8 wardley-maps-book.adoc