Rebuilding removes dependencies on python2.5
[serna.git] / INSTALL
1     Syntext Serna Free Edition build and install instructions.
2         
3 1. Prerequisites.
4
5 1.1. Operating systems.
6
7     Serna Free Edition builds were tested on the following platforms:
8     
9   a. Windows XP Service Pack 3
10   b. Fedora 10
11   c. MacOS 10.5
12
13 1.2. C++ compiler
14
15   Serna build requires g++ 4.1+ compiler on Linux and 
16   Microsoft Visual C++ 2008 Express on Windows. 
17   MacOS build requires g++ 4.0.x (installed with Xcode 3.1.2)
18
19 1.3. Tools and libraries
20
21   Required tools are:
22   
23     flex
24     bison
25     grep
26     sed
27     cat
28     bzip2
29     gzip
30     patch
31     tar
32     zip
33     unzip
34     perl
35
36   Since default Windows install does not include these tools, it's necessary to 
37   install the following packages to successfully build and install Serna on Windows:
38   
39   a. ActiveState Perl 5.x (http://www.activestate.com/activeperl)
40   b. Cygwin utilities (http://www.cygwin.com)
41
42      Make sure to install 
43        1. zip and unzip from Archive category
44        2. bison and flex from Devel category
45        3. patch from Utils category
46
47   c. Inno Setup 5 (http://www.jrsoftware.org)
48   
49   Linux systems require X11, zlib and ncurses development libraries to build third-party 
50   packages used by Serna. To generate RPM packages rpm and rpmbuild are needed.
51   
52 2. Build process.
53
54 2.1. Third-party libraries and tools.
55
56   Serna uses the following third-party packages:
57   
58   a. ANTLR parser generator version 2.7.1
59   b. GNU Aspell version 0.50.5
60   c. IBM DITA Open Toolkit version 1.4
61   d. DocBook stylesheets version 1.68.1
62   e. Doxygen documentation generator version 1.5.1
63   f. GNU iconv library version 1.11
64   g. libxml2 version 2.6.27 - The XML C parser and toolkit
65   h. libxslt version 1.1.19 - XSLT support for libxml2
66   i. PyQt version 4.4.4 - Python bindings for Qt library
67   j. Python version 2.6.2
68   k. QScintilla For Qt 4 text editor version 2.4
69   l. Nokia Qt framework version 4.5.2
70   m. Qt property browser framework version 2.5
71   n. SIP - Python C/C++ Bindings Generator version 4.8.2
72   o. Sun JDK 1.6.0
73   
74 2.2. Building Serna.
75
76   a. Unpack Syntext Serna distribution package.
77   b. Create 'packages' subdirectory in the '3rd' directory
78   c. Place third-party packages in the 'packages' subdirectory
79      
80      Package archives that are platform independent:
81      
82        antlr-2.7.1.tar.gz
83        aspell-0.50.5.tar.bz2
84        DITA-OT1.4_fullpackage_bin.tar.gz
85        docbook-xsl-1.68.1.tar.bz2
86        doxygen-1.5.1.src.tar.gz
87        libiconv-1.11.tar.gz
88        libxml2-2.6.27.tar.gz
89        libxslt-1.1.19.tar.gz
90        PyQt-x11-gpl-4.5.4.tar.gz
91        Python-2.6.2.tar.bz2
92        QScintilla-gpl-2.4.tar.gz
93        qtpropertybrowser-2.5-opensource.tar.gz
94        sip-4.8.2.tar.bz2
95        qt-all-opensource-src-4.5.2.tar.bz2
96        
97      Windows packages:
98      
99        jdk-win32-1.6.0.tar.bz2
100      
101      Linux packages:
102      
103        jdk-linux-1.6.0.tar.bz2
104      
105      Packages can be downloaded from Syntext website at
106      
107        http://www.syntext.com/downloads/serna-free/
108   
109   d. Run build.sh on Linux/MacOS or build.bat on Windows
110   
111      Build produces installation packages that are placed
112   
113      on Windows: dist\serna-4.2.0-YYYYMMDD.exe
114
115      on Linux: rpm/RPMS/i686/serna-4.2.0-YYYYMMDD.i686.rpm
116
117      on MacOS: build/serna/serna-4.2.0-YYYYMMDD.dmg
118
119 3. Installing Serna
120
121   Serna can be installed using standard installation methods for each OS 
122   it can be built on. 
123
124   To run Serna on Windows it's required to install Microsoft Visual C++ 2008 
125   Redistributable Package which can be downloaded from Microsoft
126   (http://www.microsoft.com/downloads/details.aspx?FamilyID=9b2da534-3e03-4391-8a4d-074b9f2bc1bf)