Pikselo
=======

Pikselo is a free and open-source raster graphics editor for GNU/Linux tailored
to create and edit sprites and animations.  It draws inspiration from other
raster editors, such as Gimp[1], but features an user interface that is both
simpler and more focused to pixel art, specially for pixel art used in games.

[1]: http://www.gimp.org/


Installation
------------

Requirements to install from source
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Pikselo is written in Vala[2] and uses GTK+[3] for the user interface.
However, the Vala source is converted to C code when distributing the source
packages and, as such, the only requirements to build source releases are:

 - Any modern make[4] variant; GNU Make[5] is recommended.
 - GTK+ version 3.0 or higher.
 - pkg-config[6] version 0.15 or higher.

If you plan to modify Pikselo's source code, add translation, or are building
from a fresh source clonse, additionally you will need:

 - autoconf[7] version 2.60 or higher.
 - automake[8] version 1.11 or higher.
 - Vala compiler version 0.12 or higher.
 - gnome-doc-utils[9] 0.20.0 or higher.

[2]: http://live.gnome.org/Vala
[3]: http://www.gtk.org/
[4]: http://en.wikipedia.org/wiki/Make_(software)
[5]: http://www.gnu.org/software/make/
[6]: http://www.freedesktop.org/wiki/Software/pkg-config
[7]: http://www.gnu.org/software/autoconf/
[8]: http://www.gnu.org/software/automake/
[9]: http://live.gnome.org/GnomeDocUtils


Building
~~~~~~~~

To build Pikselo from a source distribution first you need to configure the
package according to your system.  This is done by running the `configure'
shell script found in Pikselo's root directory:

  ./configure

Please note that due a limitation of the way Pikselo's build system looks for
the Vala source files, it is not currently possible to execute the `configure'
script from any other directory other than Pikselo's root.

Once the `configure' shell script has finished successful, build the
application with `make':

  make

Unfortunately, Pikselo needs to be installed in the system for it to find some
of its required files and can't be run directly from the directory where it has
been built.  To install Pikselo, make sure you have enough permissions to do so
and run `make' with the `install' parameter:

  make install

Please, refer to the file named `INSTALL' distributed along with Pikselo for
more information about building and installing this software.


License
-------

Pikselo is free software: you can redistribute it and/or modify it under the
terms of the GNU General Public License (GPL) as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later
version.

Pikselo is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE.  See the GNU General Public License for more details.

The icons used in Pikselo come from the GIMP project and are also distributed
under the terms of the GNU General Public License version 3 or later.  For more
information see http://www.gimp.org/.

You should have received a copy of the GNU General Public License in a file
named `COPYING' along with Pikselo.  If not, see http://www.gnu.org/licenses/.

The `minizip' library is copyright (c) 1998-2005 Gilles Vollant and distributed
under the zlib license.
