diff options
| author | Wladimir J. van der Laan <laanwj@gmail.com> | 2016-04-03 14:26:46 +0200 |
|---|---|---|
| committer | Wladimir J. van der Laan <laanwj@gmail.com> | 2016-04-03 14:29:11 +0200 |
| commit | f9d7091c3b04fd9aa067ed1c087a29faac55d640 (patch) | |
| tree | ea6e56948ac97dd3364860694b67abd73d9059d8 | |
| parent | 27e0d29863bcf80520993574415f79b32312c5fb (diff) | |
| download | yosys-f9d7091c3b04fd9aa067ed1c087a29faac55d640.tar.gz yosys-f9d7091c3b04fd9aa067ed1c087a29faac55d640.tar.bz2 yosys-f9d7091c3b04fd9aa067ed1c087a29faac55d640.zip | |
Add instructions for building manual on Ubuntu
| -rw-r--r-- | README | 29 |
1 files changed, 29 insertions, 0 deletions
@@ -383,3 +383,32 @@ from SystemVerilog: - The keywords "always_comb", "always_ff" and "always_latch", "logic" and "bit" are supported. +Building the documentation +========================== + +On Ubuntu, texlive needs these packages to be able to build the manual: + + sudo apt-get install texlive-binaries + sudo apt-get install texlive-science # install algorithm2e.sty + sudo apt-get install texlive-bibtex-extra # gets multibib.sty + sudo apt-get install texlive-fonts-extra # gets skull.sty and dsfont.sty + sudo apt-get install texlive-publishers # IEEEtran.cls + +Also the non-free font luximono should be installed, there is unfortulately +no Ubuntu package for this so it should be installed separately using +`getnonfreefonts`: + + wget https://tug.org/fonts/getnonfreefonts/install-getnonfreefonts + sudo texlua install-getnonfreefonts # will install to /usr/local by default, can be changed by editing BINDIR at MANDIR at the top of the script + getnonfreefonts luximono # installs to /home/user/texmf + +Then execute, from the root of the repository: + + make manual + +Notes: + +- To run `make manual` you need to have installed yosys with `make install`, + otherwise it will fail on finding `kernel/yosys.h` while building + `PRESENTATION_Prog`. + |