source: 3DVCSoftware/branches/HTM-8.2-dev0-MediaTek/doc/README_software-manual.txt @ 715

Last change on this file since 715 was 608, checked in by tech, 11 years ago

Merged DEV-2.0-dev0@604.

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