build: depends on cairo-gobject if introspection is enabled
[adg.git] / README.md
blob76fd0a6c1ca5be0d42c4d60620085292af4f2442
1 General information
2 ===================
4 Automatic Drawing Generation is GObject-based library that provides
5 a non-interactive cairo canvas specifically designed for generating
6 technical drawings. It can be viewed as a tool for programmatically
7 representing an abstract model into a layout (2D drafting).
9 If you want to develop an application that needs to show and print
10 drawings where some data change but the overall design is similar,
11 the ADG library can be quite useful. In manufacturing industries
12 this is often the case and an ADG-based application could help to
13 greatly improve the productivity of technical offices.
15 You could reach similar targets using parametric CADs but a custom
16 application provides the following benefits:
18  * more customizable;
19  * quicker and not so bloated as a parametric CAD;
20  * can be easily connected to a database;
21  * an ADG based filter can generate drawing on-fly: this feature
22    could be used in web-based applications.
24 Visit the [ADG web site](http://adg.entidi.com/) for further
25 details.
28 Design overview
29 ===============
31 The project is based on the [GObject](http://www.gtk.org/) library:
32 the ADG canvas is developed in plain C using an object-oriented
33 approach. Applications based on ADG are not expected to be
34 developed in C, though: the basic idea is to have a set of language
35 bindings for higher level languages (the garbage-collected ones,
36 above all). An application can then be developed using any
37 specific language available, much in the same way as
38 [GNOME](http://www.gnome.org/) applications are conceived.
40 The mathematical and geometrical algorithms, together with a bunch
41 of other useful functions for manipulating cairo paths, are kept
42 in a separated library called [CPML](http://adg.entidi.com/cpml/)
43 (Cairo Path Manipulation Library). Although actually embedded into
44 the ADG project, this library can be easily splitted on its own,
45 if needed.
47 The rendering leverages [cairo](http://cairographics.org/), so the
48 ADG canvas fully shares strong and weak points of that library.
49 Most notably, the availables export formats include PostScript,
50 SVG, PDF, PNG but no CAD specific ones (such as DXF). A complete
51 list can be [browsed online](http://cairographics.org/backends/).
54 External dependencies
55 =====================
57 The ADG library has the following dependencies:
59  * [cairo](http://cairographics.org/) 1.7.4 or later, required by
60    either CPML and ADG;
61  * [GLib](http://www.gtk.org/) 2.10.1 or later, required by ADG;
62  * [GTK+](http://www.gtk.org/) 3.0.0 or later (or GTK+ 2.12.0 or
63    later for GTK+2 support) to optionally include GTK+ support and
64    build the adg-demo program;
65  * [gtk-doc](http://www.gtk.org/gtk-doc/) 1.9 or later (optional),
66    used to regenerate the API documentation
67  * [GObject introspection](http://live.gnome.org/GObjectIntrospection)
68    0.9.5 or later (optional) to dinamically generate bindings
69    metadata.
71 The ADG is mainly developed on GNU/Linux but its dependecies are
72 known to be cross platform so a porting should be quite easy, if
73 not automatic. Anyway, the cross-compilation of a Windows
74 installer is supported upstream and it is based on the ArchLinux
75 [Fedora mingw port](http://github.com/ntd/aur-fedora-mingw).