Code

Add some more forgotten files
[inkscape.git] / README
2 Inkscape. Draw Freely.
3 ======================
5 http://www.inkscape.org/
7 Inkscape is an open source drawing tool with capabilities similar to
8 Illustrator, Freehand, and CorelDraw that uses the W3C standard scalable
9 vector graphics  format (SVG). Some supported SVG features include
10 basic shapes, paths, text, markers, clones, alpha blending, transforms,
11 gradients, and grouping. In addition, Inkscape supports Creative Commons
12 meta-data, node-editing, layers, complex path operations, text-on-path,
13 and SVG XML editing. It also imports several formats like EPS, Postscript,
14 JPEG, PNG, BMP, and TIFF and exports PNG as well as multiple vector-based
15 formats.
17 Inkscape's main motivation is to provide the Open Source community
18 with a fully W3C compliant XML, SVG, and CSS2 drawing tool. Additional
19 planned work includes conversion of the codebase from C/Gtk to C++/Gtkmm,
20 emphasizing a lightweight core with powerful features added through
21 an extension mechanism, and the establishment of a friendly, open,
22 community-oriented development processes.
24 Inkscape uses the standard procedure for compilation and installation: 
26   ./configure
27   make
28   make install
30 If a "./configure" file is not present, you can create it by running
31 the "./autogen.sh" command, which calls in turn a number of other
32 programs such as automake and autoconf.  See INSTALL for more
33 details. 
36 Required Dependencies
37 =====================
38 The Inkscape core depends on several other libraries that you will need
39 install, if they're not already present on your system.  The most
40 typical libraries you may need to install are:
42    * Boehm-GC 
43    * libsigc++
44    * glibmm  
45    * gtkmm  
47 Please see http://wiki.inkscape.org/wiki/index.php/CompilingInkscape for the
48 most current dependencies, including links to the source tarballs.
51 Extension Dependencies
52 ======================
53 Inkscape also has a number of extensions for implementing various
54 features such as support for non-SVG file formats, etc.  In theory, all
55 extensions are optional, however in practice you will want to have these
56 installed and working.  Unfortunately, there is a great deal of
57 variability in how you can get these functioning properly.  Here are
58 some recommendations:
60 First, make sure you have Perl and Python.  If you're on Windows you
61 should also install Cygwin.
63 Next, you'll need to ensure the dependencies for each extension is
64 present.  Depending on which extensions you need, the dependencies are
65 going to vary, but here are some you may need to install:
67    * XML::Parser
68    * XML::XQL
70 If you install dependencies to non-standard locations, such as
71 installing XML::Parser someplace in your home directory, you may need to
72 take some extra steps to indicate where those dependencies are to be
73 found.  For instance, with Perl modules, set the PERLLIB or PERL5LIB
74 variable (see `man perlrun`)