X-Git-Url: https://jxself.org/git/?p=ibg.git;a=blobdiff_plain;f=README.md;h=e90ea9345bedf700d090ac1767bc232fa7507c1c;hp=6c0485f6718730ec3b88c6b23cd14f7d9ad934bf;hb=9eb5de056be1d88d440d391ac5030dd05fe6a3a8;hpb=32e6323676b92eb33f4d8300e790003303be3cc1 diff --git a/README.md b/README.md index 6c0485f..e90ea93 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,17 @@ -Inform Beginner's Guide, 4th Edition -==================================== +Inform Beginner's Guide +======================= Introduction ------------ -This repository contains the sources for the 4th edition of the +This repository contains the sources for the [Inform Beginner's Guide](http://www.firthworks.com/roger/IBG.html), -henceforth known as the IBG. The new edition will be in a new source -format that's more contributor-friendly (see below). It's a -work-in-progress; see the [issue tracker](https://github.com/i6/ibg/issues) -for how it's going. +henceforth known as the IBG. This version is in a new source format that's +more contributor-friendly (see below). It's a work-in-progress; see the +[issue tracker](https://github.com/i6/ibg/issues) for how it's going. -The rationale for this 4th edition is: +Initially it will be a straight conversion of the 3rd edition. After that, +the 4th edition will be prepared. The rationale for a 4th edition is: * There have been quite a few updates to Inform and its support libraries in the time since 2004, when the 3rd edition was published. @@ -36,6 +36,16 @@ guide from a command prompt, like this: make html +For building the PDF version, you need a reasonably recent installation of +TeX Live. Release 2014 will do. You will also need the Emerald font +package from https://www.ctan.org/tex-archive/fonts/emerald/. This cannot +be installed with `tlmgr`, nor does it seem to be packaged by the usual +Linux or BSD distributions. Scripts for installing and uninstalling +Emerald are provided in the `tools` directory. When you're ready, type +this: + + make latexpdf + Other formats are available; just type `make` for more details. Conversion strategy @@ -58,7 +68,7 @@ So, it's back to my original plan: use the PDF file. Here's the first (major) part of the work: * Dump the text out of the PDF file -* Convert all the text to Sphinx format +* Convert all the 3rd edition text to Sphinx format * Get the online version to look good After that comes the 4th edition changes, hopefully in collaboration with