1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
Installation guide
==================
Requirements
------------
Synopsis uses features found in Python 2.2 and up.
The build system requires a posix environment with GNU make and GNU
autoconf installed.
However, it is possible to build Synopsis for a native windows
platform, running with the win32 python installation and emulating
a MSVC compiler.
Configuring
-----------
* If the sources are checked out from svn, run './autogen.sh' to generate
the configure scripts. This step requires autoconf to be installed.
* Run 'python setup.py config' to configure the subprojects.
* Be careful to pass the same '--prefix' option you are going to pass
to the 'install' command, if you plan to install synopsis. See
the section about installing for details.
Building
--------
* Run 'python setup.py build' to compile everything.
This will place all files that are going to be installed under build/
This step requires GNU make to be installed. If the executable 'make'
is not GNU make, you have to set the 'MAKE' environment variable to
GNU make.
If you do not want to install, but rather try synopsis out from within the
source directory, you may consider 'python setup.py build_ext --inplace'
as an alternative, which will only compile the C/C++ extensions and put
them right into the source tree.
* To build for windows native, just use the appropriate python interpreter
to run the build script. You will need a mingw-compatible version of the
python library (libpythonxx.a), which you have to build first. Instructions
for this are at http://www.python.org/doc/current/inst/index.html.
* If you want to use an external garbage collector for the Cxx parser
instead of the built in one, run
'python setup.py config --with-gc-prefix=/your/gc/prefix'
Testing
-------
* The tests require version 2.2 of qmtest (http://www.qmtest.com),
as well as tidy (http://www.w3.org/People/Raggett/tidy/)
* run 'python setup.py test [--suite=<id>]' where the optional
argument --suite specifies a test suite to run. The default
is to run all tests.
Building documentation
----------------------
* 'python setup.py build_doc' will compile printable and html versions of
the Tutorial as well as the Manual, and put them under share/doc/Synopsis
* All four targets require xsltproc, and the printable Tutorial requires
additionally fop (from http://xml.apache.org)
* If you only want to build the html versions, run
'python setup.py build_doc --html'
* If you only want the Tutorial, run 'python setup.py build_doc --tutorial'
* etc.
Installing
----------
* To install synopsis in <prefix>, run 'python setup.py install --prefix=<prefix>'
The default prefix is the one from the python interpreter used during the build.
* If documentation was built before, it will be installed into
<prefix>/share/doc/Synopsis
Using Synopsis
--------------
* Remember to set the PYTHONPATH variable if necessary.
* Read the tutorial to learn how to get started using synopsis.
Reporting Bugs
--------------
Please report bugs to http://synopsis.fresco.org/issues
|
