Skip to content

Commit

Permalink
Merge branch 'master' of github.com:andrewharmellaw/wardley-maps-book
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewharmellaw committed Apr 6, 2018
2 parents 12cffb6 + e62952e commit 2c7e7da
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,27 @@
# 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
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
Expand Down

0 comments on commit 2c7e7da

Please sign in to comment.