Skip to content

Commit

Permalink
Improve building instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
robertoaloi authored Apr 12, 2017
1 parent 4e06090 commit de4046f
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,23 +28,25 @@ stable release](https://github.com/happi/theBeamBook/releases/latest).
Alternatively you can create your own PDF from the source code
following the instructions below.

## Building on Linux
## Building from source

To build a PDF version of the book from source, simply run:
### Docker

```shell
make
```
Since the above command requires a number of dependencies (including
erlang, asciidoc and dblatex), a Docker image containing everything
A Docker image containing everything
which is needed to build the book from source is provided. To use it:

```shell
docker pull robertoaloi/docker-thebeambook:latest
docker run -v $PWD:/book robertoaloi/docker-thebeambook make
```

## Building on Mac OSX
### Linux

```shell
make
```

### Mac OSX

1. Install [MacTex](http://www.tug.org/mactex/). Note that you would need to _full_ MacTex rather than just BasicTex.
1. Add `/Library/TeX/texbin` to your `PATH`.
Expand All @@ -54,7 +56,7 @@ docker run -v $PWD:/book robertoaloi/docker-thebeambook make
1. Install wget
1. `make`

## Building on Mac OSX (with brew)
## Mac OSX (using brew)

1. `brew install Caskroom/cask/mactex`
1. Add `/Library/TeX/texbin` to your `PATH`.
Expand Down

0 comments on commit de4046f

Please sign in to comment.