README

   1
   2 Inkscape. Draw Freely.
   3 ======================
   4
   5 http://www.inkscape.org/
   6
   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.
  16
  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.
  23
  24
  25 Basic Installation
  26 ==================
  27
  28 Inkscape uses the standard procedure for compilation and installation:
  29
  30   ./configure
  31   make
  32   make install
  33
  34 If a "./configure" file is not present, you can create it by running
  35 the "./autogen.sh" command, which calls in turn a number of other
  36 programs such as automake and autoconf.  See INSTALL for more
  37 details.
  38
  39 For platform specific instructions please read the README file that
  40 is associated with that platform (e.g. for Mac OS X read README.osx)
  41
  42
  43 Required Dependencies
  44 =====================
  45 The Inkscape core depends on several other libraries that you will need
  46 install, if they're not already present on your system.  The most
  47 typical libraries you may need to install are:
  48
  49    * Boehm-GC
  50    * libsigc++
  51    * glibmm
  52    * gtkmm
  53
  54 Please see http://wiki.inkscape.org/wiki/index.php/CompilingInkscape for the
  55 most current dependencies, including links to the source tarballs.
  56
  57
  58 Extension Dependencies
  59 ======================
  60 Inkscape also has a number of extensions for implementing various
  61 features such as support for non-SVG file formats, etc.  In theory, all
  62 extensions are optional, however in practice you will want to have these
  63 installed and working.  Unfortunately, there is a great deal of
  64 variability in how you can get these functioning properly.  Here are
  65 some recommendations:
  66
  67 First, make sure you have Perl and Python.  If you're on Windows you
  68 should also install Cygwin.
  69
  70 Next, you'll need to ensure the dependencies for each extension is
  71 present.  Depending on which extensions you need, the dependencies are
  72 going to vary, but here are some you may need to install:
  73
  74    * XML::Parser
  75    * XML::XQL
  76
  77 If you install dependencies to non-standard locations, such as
  78 installing XML::Parser someplace in your home directory, you may need to
  79 take some extra steps to indicate where those dependencies are to be
  80 found.  For instance, with Perl modules, set the PERLLIB or PERL5LIB
  81 variable (see `man perlrun`)
  82