Move README.html to README.md (more github-friendly).

This commit is contained in:
David Capello 2012-05-03 23:01:45 -03:00
parent 37fd3c1d98
commit e6021de616
2 changed files with 133 additions and 282 deletions

View File

@ -1,282 +0,0 @@
<!DOCTYPE html>
<head>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type"/>
<title>ASEPRITE</title>
<style text="text/css">
body { font-family:sans-serif; font-size:11pt; }
a { text-decoration:none; }
a:hover { text-decoration:underline; }
#page { width:600px; margin-left:auto; margin-right:auto; }
#title { font-size:20pt; color:#51b6cf; }
#subtitle { font-size:12pt; color:#aaf; }
#warning { font-size:12pt; color:#f77; background-color:#fee; border:1px solid #f77; padding:8px; margin:8px auto; width:80%; }
#footer { font-size:10pt; color:#aaa; border-top:1px solid #aaa; }
h1 { font-size:14pt; font-weight:bold; color:#080; }
h2 { font-size:12pt; font-weight:bold; color:#0a0; }
p { margin-left:8px; }
.author { margin-left:8px; }
.details { margin-left:16px; margin-bottom:8px; color:#aaa; }
.details a { display:block; }
.library { margin:8px; background-color:#7ddbf3; border:4px solid #7ddbf3; border-radius:4px; }
.library-license { margin-left:16px; margin-bottom:8px; color:#aaa; display:none; }
pre { background-color:#e0f0e0; padding:8px; margin-left:32px; }
</style>
</head>
<body>
<div id="page">
<div id="title">ASEPRITE</div>
<div id="subtitle">Copyright &copy; 2001-2012 David Capello</div>
<div id="warning">
THIS PROGRAM IS DISTRIBUTED WITHOUT ANY WARRANTY<br/>
See <a href="#license">license</a> section for more information.
</div>
<h1>TABLE OF CONTENTS</h1>
<p id="tableofcontent">
<a href="#introduction">Introduction</a><br/>
<a href="#features">Features</a><br/>
<a href="#configuration_files">Configuration Files</a><br/>
<a href="#contact_information">Contact Information</a><br/>
<a href="#license">License</a><br/>
<a href="#authors">Authors</a><br/>
</p>
<a name="introduction"></a><h1>INTRODUCTION</h1>
<p>
<b>ASEPRITE</b> is an open source program to create animated
sprites. Sprites are little images that can be used in your website
or in a video game. You can draw characters with movement, intros,
textures, patterns, backgrounds, logos, color palettes, isometric
levels, etc.
</p>
<p>
What makes ASEPRITE different? It focuses on pixel editing, to do
pixel-art. Indeed, it isn't a photo retouching tool or a vector
graphics editor. Mainly it is a tool to create tiny animations
pixel-by-pixel.
</p>
<a name="features"></a><h1>FEATURES</h1>
<p>
The main features of ASEPRITE are:
</p>
<p>
<ul>
<li>
Sprites are composed by <b>layers</b> &amp; <b>frames</b>.
</li>
<li>
Supported color modes: <b>RGBA</b>, <b>Indexed</b> (palettes up to 256 colors), and Grayscale.
</li>
<li>
Supported image formats (load/save): <b>PNG</b>, <b>GIF</b>, JPG, FLC, FLI, BMP, PCX, TGA, and ASE (special format).
</li>
<li>
Load and save animations in a <b>sequence of bitmaps</b> (e.g. frame1.png, frame2.png, etc.).
</li>
<li>
<b>Tiled</b> drawing mode, useful to draw <b>patterns</b> and textures.
</li>
<li>
<b>Undo/Redo</b> for every operation.
</li>
<li>
<b>Multiple editors</b> support. You can split an editor horizontally or vertically multiple times
to edit and view the same sprite with different zooms, or different sprites.
</li>
<li>
Import/Export <b>Sprite Sheets</b>.
</li>
<li>
Pixel art specific tools like filled <b>Contour</b> &amp; <b>Polygon</b>.
</li>
<li>
<b>Onion skinning</b>.
</li>
</ul>
</p>
<a name="configuration_files"></a><h1>CONFIGURATION FILES</h1>
<p>
In Windows XP/Vista/7 the main configuration file is
<em>aseprite.ini</em> which is saved in the same folder of
<em>aseprite.exe</em>
executable file (in this way ASEPRITE is a portable
application, i.e. you can transport a copy of the program
in your USB drive).
</p>
<p>
The following is a list of all configuration files that you could
modify (it is not recommended to do so, but is useful if you want to
<em>super</em>-customize ASEPRITE):
<p>
<p>
<pre>aseprite.ini Program configuration
data/gui.xml Menus, shortcuts, and tools
data/convmatr.def Convolutions matrices
data/skins/*.* ASEPRITE skins
data/widgets/*.xml XML files with dialogs</pre>
</p>
<p>
In GNU/Linux, the configuration file is ~/.asepriterc, and
the data/ files are searched in these locations (in priority
order):
</p>
<p>
<pre>$HOME/.aseprite/
../share/aseprite/
./data/</pre>
</p>
<a name="contact_information"></a><h1>CONTACT INFORMATION</h1>
<p>You can report problems (bugs) or features in the Google Code project:</p>
<p>
<ul>
<li><a href="http://code.google.com/p/aseprite/issues/entry">Bugs</a></li>
<li><a href="http://code.google.com/p/aseprite/issues/entry?template=New%20feature">Request features</a></li>
<li><a href="http://groups.google.com/group/aseprite-discuss">ASEPRITE Group</a> (<a href="mailto:aseprite-discuss+subscribe@googlegroups.com">subscribe</a>)</li>
</ul>
</p>
<p>
For more information, visit the official page of the project:
</p>
<p>
<a href="http://www.aseprite.org/">http://www.aseprite.org/</a>
</p>
<a name="license"></a><h1>LICENSE</h1>
<p>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
</p>
<p>
This program 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.
</p>
<p>
You should have received a copy of the <a href="docs/licenses/GPL.txt">GNU General Public License</a>
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
USA
<p>
<a name="authors"></a><h1>AUTHORS</h1>
<div class="author">David Capello &lt;<a href="mailto:davidcapello@gmail.com">davidcapello@gmail.com</a>&gt;</div>
<div class="details">
Programmer, designer, and maintainer.
<a href="http://dacap.com.ar/">http://dacap.com.ar/</a>
</div>
<div class="author">Ilija Melentijevic</div>
<div class="details">
New GUI skin (from ASEPRITE 0.8). A lot of good ideas.
<a href="http://ilkke.blogspot.com/">http://ilkke.blogspot.com/</a>
<a href="http://www.pixeljoint.com/p/9270.htm">http://www.pixeljoint.com/p/9270.htm</a>
</div>
<div class="author">Contributors</div>
<div class="details">
<a href="http://code.google.com/p/aseprite/people/list">http://code.google.com/p/aseprite/people/list</a>
</div>
<p>
Thanks to all the people who have contributed ideas, patches, bugs
report, feature requests, donations, and help me developing
ASEPRITE.
</p>
<a name="thankfulness"></a><h2>CREDITS</h2>
<p>
ASEPRITE uses libraries or parts of the original source code
of the following projects created by third-parties:
</p>
<div class="library">
Allegro 4
| <a href="http://alleg.sourceforge.net/">homepage</a>
| <a href="docs/licenses/allegro4-LICENSE.txt">license</a>
</div>
<div class="library">
AllegroFont
| <a href="http://chernsha.sitesled.com/">homepage</a>
| <a href="docs/licenses/FTL.txt">license</a>
</div>
<div class="library">
curl
| <a href="http://curl.haxx.se/">homepage</a>
| <a href="docs/licenses/curl-LICENSE.txt">license</a>
</div>
<div class="library">
FreeType
| <a href="http://www.freetype.org/">homepage</a>
| <a href="docs/licenses/FTL.txt">license</a>
</div>
<div class="library">
giflib
| <a href="http://sourceforge.net/projects/giflib/">homepage</a>
| <a href="docs/licenses/giflib-LICENSE.txt">license</a>
</div>
<div class="library">
GIMP
| <a href="http://www.gimp.org/">homepage</a>
| <a href="docs/licenses/GPL.txt">license</a>
</div>
<div class="library">
GTK+
| <a href="http://www.gtk.org/">homepage</a>
| <a href="docs/licenses/LGPL-2.1.txt">license</a>
</div>
<div class="library">
Google Test
| <a href="http://code.google.com/p/googletest/">homepage</a>
| <a href="docs/licenses/gtest-LICENSE.txt">license</a>
</div>
<div class="library">
libart
| <a href="http://www.levien.com/libart/">homepage</a>
| <a href="docs/licenses/LGPL-2.0.txt">license</a>
</div>
<div class="library">
libjpeg
| <a href="http://www.ijg.org/">homepage</a>
| <a href="docs/licenses/libjpeg-LICENSE.txt">license</a>
</div>
<div class="library">
libpng
| <a href="http://www.libpng.org/pub/png/">homepage</a>
| <a href="docs/licenses/libpng-LICENSE.txt">license</a>
</div>
<div class="library">
loadpng
| <a href="http://tjaden.strangesoft.net/loadpng/">homepage</a>
| <a href="docs/licenses/ZLIB.txt">license</a>
</div>
<div class="library">
tinyxml
| <a href="http://www.sourceforge.net/projects/tinyxml">homepage</a>
| <a href="docs/licenses/ZLIB.txt">license</a>
</div>
<div class="library">
XFree86
| <a href="http://www.x.org/">homepage</a>
| <a href="docs/licenses/XFree86-LICENSE.txt">license</a>
</div>
<div class="library">
zlib
| <a href="http://www.gzip.org/zlib/">homepage</a>
| <a href="docs/licenses/ZLIB.txt">license</a>
</div>
<div style="margin:16px 0px;">
Other parts of code by:
</div>
<div class="author">Gary Oberbrunner</div>
<div class="details">
Code to quantize RGB images with ordered dither method.
</div>
<div id="footer">Copyright &copy; 2001-2012 David Capello</div>
</div>
</body>
</html>

133
README.md Normal file
View File

@ -0,0 +1,133 @@
# ASEPRITE
*Copyright (C) 2001-2012 David Capello*
> THIS PROGRAM IS DISTRIBUTED WITHOUT ANY WARRANTY<br/>
> See the license section for more information.
## Introduction
**ASEPRITE** is an open source program to create animated
sprites. Sprites are little images that can be used in your website or
in a video game. You can draw characters with movement, intros,
textures, patterns, backgrounds, logos, color palettes, isometric
levels, etc.
What makes ASEPRITE different? It focuses on pixel editing, to do
pixel-art. Indeed, it isn't a photo retouching tool or a vector
graphics editor. Mainly it is a tool to create tiny animations
pixel-by-pixel.
## Features
The main features of ASEPRITE are:
* Sprites are composed by **layers** &amp; **frames**.
* Supported color modes: **RGBA**, **Indexed** (palettes up to 256
colors), and Grayscale.
* Supported image formats (load/save): **PNG**, **GIF**, JPG, FLC,
FLI, BMP, PCX, TGA, and ASE (special format).
* Load and save animations in a **sequence of bitmaps**
(e.g. frame1.png, frame2.png, etc.).
* **Tiled** drawing mode, useful to draw **patterns** and textures.
* **Undo/Redo** for every operation.
* **Multiple editors** support. You can split an editor horizontally
or vertically multiple times to edit and view the same sprite with
different zooms, or different sprites.
* Import/Export **Sprite Sheets**.
* Pixel art specific tools like filled **Contour** &amp; **Polygon**.
* **Onion skinning**
## Configuration files
In Windows XP/Vista/7 the main configuration file is `aseprite.ini`
which is saved in the same folder of `aseprite.exe` executable file
(in this way ASEPRITE is a portable application, i.e. you can
transport a copy of the program in your USB drive).
The following is a list of all configuration files that you could
modify (it is not recommended to do so, but is useful if you want to
super-customize ASEPRITE):
aseprite.ini Program configuration
data/gui.xml Menus, shortcuts, and tools
data/convmatr.def Convolutions matrices
data/skins/*.* ASEPRITE skins
data/widgets/*.xml XML files with dialogs
In GNU/Linux, the configuration file is ~/.asepriterc, and the data/
files are searched in these locations (in priority order):
$HOME/.aseprite/
../share/aseprite/
./data/
## Contact Information
You can report problems (bugs) or features in the Google Code project:
* [Bugs](http://code.google.com/p/aseprite/issues/entry)
* [Request features](http://code.google.com/p/aseprite/issues/entry?template=New%20feature)
* [ASEPRITE Group](http://groups.google.com/group/aseprite-discuss) ([subscribe](mailto:aseprite-discuss+subscribe@googlegroups.com))
For more information, visit the official page of the project:
http://www.aseprite.org/
## License
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program 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.
You should have received a copy of the [GNU General Public License](docs/licenses/GPL.txt)
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
USA
## Authors
David Capello [davidcapello@gmail.com](mailto:davidcapello@gmail.com)
> Programmer, designer, and maintainer. <br />
http://dacap.com.ar/
Ilija Melentijevic
> New GUI skin (from ASEPRITE 0.8). A lot of good ideas. <br />
http://ilkke.blogspot.com/ <br />
http://www.pixeljoint.com/p/9270.htm
Contributors
> http://code.google.com/p/aseprite/people/list
Thanks to all the people who have contributed ideas, patches, bugs
report, feature requests, donations, and help me developing ASEPRITE.
## Credits
ASEPRITE uses libraries or parts of the original source code
of the following projects created by third-parties:
* [Allegro 4](http://alleg.sourceforge.net/) - [allegro4 license](docs/licenses/allegro4-LICENSE.txt)
* [AllegroFont](http://chernsha.sitesled.com/) - [FTL license](docs/licenses/FTL.txt)
* [curl](http://curl.haxx.se/) - [curl license](docs/licenses/curl-LICENSE.txt)
* [FreeType](http://www.freetype.org/) - [FTL license](docs/licenses/FTL.txt)
* [giflib](http://sourceforge.net/projects/giflib/) - [giflib license](docs/licenses/giflib-LICENSE.txt)
* [GIMP](http://www.gimp.org/) - [GPL license](docs/licenses/GPL.txt)
* [GTK+](http://www.gtk.org/) - [LGPL license](docs/licenses/LGPL-2.1.txt)
* [Google Test](http://code.google.com/p/googletest/) - [gtest license](docs/licenses/gtest-LICENSE.txt)
* [libart](http://www.levien.com/libart/) - [LGPL license](docs/licenses/LGPL-2.0.txt)
* [libjpeg](http://www.ijg.org/) - [libjpeg license](docs/licenses/libjpeg-LICENSE.txt)
* [libpng](http://www.libpng.org/pub/png/) - [libpng license](docs/licenses/libpng-LICENSE.txt)
* [loadpng](http://tjaden.strangesoft.net/loadpng/) - [zlib license](docs/licenses/ZLIB.txt)
* [tinyxml](http://www.sourceforge.net/projects/tinyxml) - [zlib license](docs/licenses/ZLIB.txt)
* [XFree86](http://www.x.org/) - [XFree86 license](docs/licenses/XFree86-LICENSE.txt)
* [zlib](http://www.gzip.org/zlib/) - [ZLIB license](docs/licenses/ZLIB.txt)
Other parts of code by:
* Gary Oberbrunner: Code to quantize RGB images with ordered dither method.