| Rev | Line | |
|---|
| [608] | 1 | Software manual instructions |
|---|
| 2 | ============================ |
|---|
| 3 | The software manual is written in plain text using LaTeX markup. |
|---|
| 4 | |
|---|
| 5 | Prerequisites |
|---|
| 6 | ------------- |
|---|
| 7 | The following tools are required to render the document: |
|---|
| 8 | - LaTeX |
|---|
| 9 | - JCT-VC document template |
|---|
| 10 | |
|---|
| 11 | The document uses the JCT-VC report class/template, available from: |
|---|
| 12 | http://hevc.kw.bbc.co.uk/git/w/jctvc-latex.git |
|---|
| 13 | |
|---|
| 14 | To install this, either -- |
|---|
| 15 | a) export the environment variable TEXINPUTS=path/to/jctvc-latex/:: |
|---|
| 16 | b) copy jctvcdoc.cls to this directory. |
|---|
| 17 | |
|---|
| 18 | NB, if performing (b), please do not commit the jctvcdoc.cls file. |
|---|
| 19 | |
|---|
| 20 | Building |
|---|
| 21 | -------- |
|---|
| 22 | A makefile is provided that will render a pdf from the LaTeX source. |
|---|
| 23 | If LaTeX is installed, typing "make" ought to be sufficient. |
|---|
| 24 | |
|---|
| 25 | Please do not commit updated PDFs to the SVN repository, this will be |
|---|
| 26 | performed by the Software AHG prior to making an HM release. |
|---|
| 27 | |
|---|
| 28 | If there are any issues with the building the document or formatting |
|---|
| 29 | the LaTeX source, please contact David Flynn <davidf@rd.bbc.co.uk>. |
|---|
Note: See
TracBrowser for help on using the repository browser.
