summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 4789a121542d9fdd284411f90e1e621d25474d41 (plain)
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
95
Inkscape. Draw Freely.
======================

[https://www.inkscape.org/](https://www.inkscape.org/)

Inkscape is an open source drawing tool with capabilities similar to
Illustrator, Freehand, and CorelDraw that uses the W3C standard scalable
vector graphics  format (SVG). Some supported SVG features include
basic shapes, paths, text, markers, clones, alpha blending, transforms,
gradients, and grouping. In addition, Inkscape supports Creative Commons
meta-data, node-editing, layers, complex path operations, text-on-path,
and SVG XML editing. It also imports several formats like EPS, Postscript,
JPEG, PNG, BMP, and TIFF and exports PNG as well as multiple vector-based
formats.

Inkscape's main motivations are to provide the Open Source community
with a fully W3C compliant XML, SVG, and CSS2 drawing tool emphasizing a
lightweight core with powerful features added as extensions, and the
establishment of a friendly, open, community-oriented development
processes.

[![build status](https://gitlab.com/inkscape/inkscape/badges/master/build.svg)](https://gitlab.com/inkscape/inkscape/commits/master)

Basic Installation
==================

Inkscape version 0.92 and newer can be build using cmake:

```bash
mkdir build
cd build
cmake ..
make
make install
```

Other platforms such as Windows and Mac require a lot more and are considered
a developer and packager task. These instructions are kept on the Inkscape wiki.

Running Without Installing
==========================

For developers and others who want to run inkscape without installing it:

```bash
ln -s . share/inkscape
mkdir -p build/conf
cd build
cmake -DCMAKE_INSTALL_PREFIX:PATH=$PWD/../ ..
make -j4
export INKSCAPE_PROFILE_DIR=$PWD/conf
PATH=$PWD/bin/:$PATH
./bin/inkscape
```

This won't work for other platforms such as Windows and Mac, see above. But
what it is doing is linking the share directory into a location where
the inkscape binary will be able to find it. Allowing you to change the
inkscape shared files without rebuilding or installing.

Then setting a local configuration directory, keeping your configurations
separate from any installed version.

Required Dependencies
=====================

The Inkscape core depends on several other libraries that you will need
install, if they are not already present on your system.  The most
typical libraries you may need to install are:

   * [Boehm-GC](http://www.hboehm.info/gc/)
   * [libsigc++](http://libsigc.sourceforge.net/)
   * [gtkmm](https://www.gtkmm.org/)

Please see [the wiki page on compiling Inkscape](http://wiki.inkscape.org/wiki/index.php/CompilingInkscape) for the
most current dependencies, including links to the source tarballs.


Extension Dependencies
======================
Inkscape also has a number of extensions for implementing various
features such as support for non-SVG file formats.  In theory, all
extensions are optional, however in practice you will want to have these
installed and working.  Unfortunately, there is a great deal of
variability in how you can get these functioning properly.  Here are
some recommendations:

First, make sure you have Python.  If you are on Windows you
should also install [Cygwin](https://www.cygwin.com/).

Second, if an extension does not work, check the file
`extensions-errors.log` located on Linux at `~/.config/inkscape` and on
Windows at `%userprofile%\Application Data\Inkscape\`. Any missing
programs will be listed.