OSDN Git Service

changelog update
[mypaint-anime/master.git] / README
1 MyPaint - drawing program with dynamic brushes for graphic tablets
2
3 The license is described in the file LICENSE.
4 Documentation can be found within the program and on the homepage:
5 http://mypaint.info/
6 A list of contributors can be found in the about dialog.
7
8 Building on Linux:
9
10     Compile and run:
11
12         $ scons
13         $ ./mypaint
14
15     Install:
16
17         # scons prefix=/usr/local install
18
19     Uninstall:
20
21         # scons prefix=/usr/local install --clean
22
23     Install (for packagers):
24
25         $ scons prefix=/usr --install-sandbox=path/to/sandbox
26
27             (NOTE: the sandbox location must be located under the
28             current working directory. The above installs the main
29             launch script as "./path/to/sandbox/usr/bin/mypaint".
30             Use a symlink if that's too limiting.)
31
32
33     Required: pygtk, python, swig, gtk, numpy, pycairo(>=1.4), libpng
34
35     Debian users can fetch these dependencies by running:
36
37         # apt-get install g++ python-dev libglib2.0-dev python-numpy \
38                           swig scons gettext libpng12-dev
39
40     Recommended: a pressure sensitive input device (graphic tablet)
41
42
43     Take care to update the icon theme cache for your $prefix if you're
44     installing mypaint to a location which has one of these files already. If
45     you install new icons, any existing icon cache must be updated too,
46     otherwise MyPaint won't be able to find its icons even if it looks in the
47     right place. For example for an install into /usr (which has one on most
48     systems), you should run
49
50         $ gtk-update-icon-cache /usr/share/icons/hicolor
51         $ chmod a+r /usr/share/icons/hicolor/icon-theme.cache
52
53     after installation to ensure that the cache is up to date. Scons won't
54     do this for you because the cache file is optional.
55
56     If you install to /usr/local, you may need to run this instead:
57
58         $ gtk-update-icon-cache --ignore-theme-index /usr/local/share/icons/hicolor
59
60
61 Building on Windows:
62
63     NOTE: This is still very experimental.
64     If you'd much rather simply have a semi-recent pre-build version of MyPaint for Windows,
65     downloads should be available on the website.
66
67     NOTE: This page might contain more up to date instructions:
68     http://opensourcepack.blogspot.com/2009/08/building-mypaint-in-windows.html
69
70     To build on a Windows platform there are a handful of things you need to setup before building.
71     As the very first step you should make sure you have the following things installed correctly on your system:
72         
73         Tools:
74             SCons
75             MinGW (or the like)
76             Python 2.5 (or possibly above)
77             SWIG
78             pkg-config
79         
80         Libs:
81             GTK+
82             (And for Python:)
83             PyGTK
84             PyGObject
85             PyCairo
86             PIL
87             Numpy
88             Numeric ( This is the predecessor to Numpy, and dependency might depend on your choice of other libs - you might actually not need it )
89         
90     When everything is installed you will most likely have to set the following Environmet Variables under Windows.
91     These will naturally need to reflect the way you installed the above mentioned tools and libs.
92     The variables and example values are given here:
93         
94         PATH                        =   "C:\MinGW\bin;C:\GTK\bin;C:\swig;C:\Python25;C:\Python25\Scripts;"
95         PYTHONPATH          =   "C:\Python25\Lib\site-packages"
96         PKG_CONFIG_PATH =   "C:\Python25\Lib\pkgconfig"
97
98         ( The following is handy for debugging purpose, but should only be use when needed - NOT required ! )
99         PYTHONVERBOSE       =   "1"
100     
101     Along the line you will most likely also have to make the missing ".pc" files for pkg-config.
102     These should be put in one of the locations specified in PKG_CONFIG_PATH.
103     Here you should have the following files:
104     
105         numpy.pc
106         pycairo.pc
107         pygobject-2.0.pc
108         pygtk-2.0.pc
109         python25.pc
110     
111     If they do not exist and are not found elsewhere in PKG_CONFIG_PATH, you have to write them yourself.
112     These files are rather simple, containing only a few lines.
113     If you're not able to create these yourself by trial'n'error, try Google some info on the format.
114
115     Fortunately once everything is set up building should be a smooth process.
116     Open the Command Prompt and simply follow these two steps:
117         
118         "cd \mypaint-trunk\"        To go the dir containing the downloaded source code.
119         "scons"                                 Start up SCons and have it read the SConstruct script.
120                                                         This is the where 'mypaint.dll' and 'mypaint.exe' (hopefully) are build.
121     
122     Now the remaining problem is to boil it all down to a reasonable clean set of files.
123     At this stage you will have to experiment a lot - and again utilize your trial'n'error skills.
124     Some of the files you'll most likely need to find are:
125     
126         ( in no particular order )
127     
128         libglib-2.0-0.dll,      libgobject-2.0-0.dll,           libpangowin32-1.0-0.dll,
129         libgmodule-2.0-0.dll,   libgdk_pixbuf-2.0-0.dll,    libgthread-2.0-0.dll,
130         libcairo-2.dll,             libpangocairo-1.0-0.dll,    libgdk-win32-2.0-0.dll,
131         libatk-1.0-0.dll,           libgio-2.0-0.dll,                   libgtk-win32-2.0-0.dll
132         libpng12-0.dll,             libpango-1.0-0.dll,
133         
134         zlib1.dll,  jpeg62.dll,     libtiff3.dll,
135         tk84.dll,       tcl84.dll,
136         
137         python25.dll,       MSVCR71.dll,    w9xpopen.exe,
138         
139         numpy.core.umath.pyd,               numpy.lib._compiled_base.pyd,
140         numpy.core.multiarray.pyd,  numpy.core.scalarmath.pyd,
141         numpy.fft.fftpack_lite.pyd, numpy.core._sort.pyd,
142         numpy.random.mtrand.pyd,        numpy.linalg.lapack_lite.pyd,
143         
144         gtk._gtk.pyd,       gobject._gobject.pyd,       cairo._cairo.pyd
145     
146     This stage is just insanity for you perfectinists out there. Noone will mind if you skip this step.
147     Likely MyPaint will run just fine, finding these files elsewhere on your system.
148     BUT! if it turns out it doesn't or if you need to run MyPaint on other systems than the one you build it on,
149     you'll still have to have these files in the directory you keep 'mypaint.exe'.
150     
151     Good luck !
152     
153     PS: If you give up along the way there should be semi-recent builds available on the website.
154     PPS: Much in line with all the shared libs metioned above,
155         the exe file is build to import two files 'python25.zip' and 'site-packages.zip'.
156         These files were ment to hold any addictional python scripts needed.
157         Examine the files from the recent Windows builds on the website for reference.