Skip to content

Commit

Permalink
Adding a more explicit list of dependencies
Browse files Browse the repository at this point in the history
This closes #146.
  • Loading branch information
mtiller committed Sep 26, 2014
1 parent 19c28eb commit 0f2013d
Showing 1 changed file with 25 additions and 15 deletions.
40 changes: 25 additions & 15 deletions README.md
Expand Up @@ -76,21 +76,31 @@ Sphinx is completely portable so in theory, it should be possible to
run Sphinx under nearly any operating system.

I wrote most of the book under MacOS, but I'm confident it can be
compiled without much effort under Linux as well. In order to compile
the complete version of the book, you need to have
[OpenModelica](https://openmodelica.org/) and a bunch of other tools.
Unfortunately, I've lost track of exactly what the dependencies are.

For Ubuntu, the requirements are listed in [requirements.txt](requirements.txt)
which you can install by doing:

$ cat requirements.txt | xargs sudo apt-get install

In addition you will need an updated development version of
[Pygments](http://pygments.org/). The easiest way is to install the updated
version of Pygments from @dietmarw by doing:

$ sudo pip install --upgrade https://bitbucket.org/dietmarw/pygments-main/get/default.tar.gz
compiled without much effort under Linux as well. For MacOSX, I used
`brew` (homebrew) to install the various tools required. For Linux,
the following commands are necessary in order to install all the tools
required to build the book:

```
$ apt-get install -y wget
$ for deb in deb deb-src; do echo "$deb http://build.openmodelica.org/apt `lsb_release -cs` stable"; done | sudo tee /etc/apt/sources.list.d/openmodelica.list
$ wget -q http://build.openmodelica.org/apt/openmodelica.asc -O- | sudo apt-key add -
$ apt-get update
$ apt-get install -y openmodelica
$ apt-get install -y python python-dev python-pip python-virtualenv
$ apt-get install -y calibre librsvg2-bin texlive-fonts-recommended
$ apt-get install -y texlive-latex-recommended texlive-latex-extra
$ apt-get install -y python-matplotlib python-pip python-scipy
$ apt-get install -y python-sphinx python-jinja2 s3cmd
$ pip install sphinx-intl
$ pip install --upgrade https://bitbucket.org/dietmarw/pygments-main/get/default.tar.gz
```

This corresponds to the `Dockerfile` in the `docker/PY` directory (for
anybody interested in building the book using a Docker container).

### Building

Expand Down

0 comments on commit 0f2013d

Please sign in to comment.