a52e51076f75c0d08a1a7fc2a5f973f27892c5a9
[jalview-manual.git] / README
1 jalviewTutorial: README
2 =======================
3
4 14th August 2008: J.B. Procter.
5
6 This is a refactored version of the Jalview Tutorial for Jalview Version 2.2
7 which was created by David Martin in 2006.
8
9 TheJalviewTutorial.tex is the main tex file.
10
11 images/
12 contain the images included in the tutorial. They are PDFs created
13 to PDF 1.5 standard (which is higher than the PDF tools available on Kinshar at time of writing).
14
15 data/
16 contains the data used to create the tutorial images and useful data artefacs
17 that might be provided to user.
18
19 Jalview Tutorial.doc is the original word document created by the Jalview 2 team giving the basic outline used to create the tutorial.
20
21
22 Building the document
23 =====================
24
25 The raw output of the tex->PDF conversion should not be checked in, only the final optimised PDF.
26
27 1. pdflatex TheJalviewTutorial.tex will (after three passes) generate a properly formatted pdf file TheJalviewTutorial.pdf
28 Caveats: ensure your pdftools cope with version 1.5 pdf files (latest pdf tools and cygwin tex packages work here).
29 2. use acrobat professional to optimise the TheJalviewTutorial.pdf
30  - reduces size from 27M to about 5M.
31  - No command line script is available to do this.
32 3. Save the optimised PDF as latest/TheJalviewTutorial.pdf and check it in when checking in the final tex file used to create it.
33
34