	 _    _
	| \  / | O  _ ___  _____  _ __  _____
	|  \/  || || `_  \/  _  \| `__|/  _  \
	| |\/| || || | | || |_| || |   | |_| |
	|_|  |_||_||_| |_||___  ||_|   \_____/
			    __| |
			   \___/   Version (alpha) a.1

  A game programming library by Burdjia.com, March 30, 2006.

  See the "authors.txt" file for a complete list of contributors.



  NOTE:  Current version is labeled as "(alpha)".  That means it is an
	 evaluation version and it wouldn't include all information you need to
	 use it.  Please, help us to finish this project sending us your
	 suggestions.  See the end of this file to find contact info.



========
Contents
========

 - Introduction
 - Features
 - License
 - Installation
 - How to use
 - Release programs
 - Help needed
 - Contact info



============
Introduction
============

  Mingro is a library indented to help amateur and begginers to create computer
  games and other types of multimedia programming.  In the beggining it was
  designed as a wrapper for the Allegro library to be used in Pascal but the
  project became too big and complex so we decided to throw out the "Allegro
  compatibility" objective and then we redesign Mingro from scratch.  Anyway,
  it still using Allegro as base library helping us to work with the not
  stardard Windows workframe and to port it to other SO and platforms.

  Current version is labeled as "(alpha)".  That means it is a previous
  unfinished version to get feedback from people that used it, as you'll do.
  Please, send us what do you think about the library, what's right and what's
  wrong.  The "(alpha)" lavel warns about this is not a library for begginers
  because there are unfinished and undocumented stuff.



========
Features
========

  NOTE:  Features labeled with "(*)" refers to funtions defined to the final
	 release that aren't yet implemented.

  Tested on Windows (98se/XP), is possible to use it on GNU/Linux, MS-DOS,
  BeOS and MacOS (with few changes).

  Drawind primitives as pixel drawint, lines, rectangles and ellipses, copy and
  paste images, etc.  Supports clipping, color palettes and turtle-style
  drawings.

  It can use text font of different sizes and colors.

  Two graphic modes: hi and lo resolution (640x480 and 320x240), double-buffer
  and simulated MSX-VDP style sprite planes.

  Plays bacground MIDI music and digited sound effects (VOC y WAV).  (*)Create
  music and sound in runtime.

  Access to mouse, keyboard and (*)joystick.

  Routines to loading and writing graphics and sound from disk files.


=======
License
=======

  Mingro is gift-ware.  It was created by a number of people working in
  cooperation, and is given to you freely as a gift.  You may use, modify,
  redistribute, and generally hack it about in any way you like, and you do not
  have to give us anything in return.  However, if you like this product you
  are encouraged to thank us by making a return gift to the Mingro community.
  This could be by writing an add-on package, providing a useful bug report,
  making an improvement to the library, or perhaps just releasing the sources
  of your program so that other people can learn from them.  If you
  redistribute parts of this code or make a game using it, it would be nice if
  you mentioned Allegro somewhere in the credits, but you are not required to
  do this.  We trust you not to abuse our generosity.

   Disclaimer:

   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT.  IN NO EVENT
   SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
   FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
   DEALINGS IN THE SOFTWARE.



============
Installation
============

  NOTE:  This installation note is for Windows precompiled version only.

  We recommend to use Free Pascal (http://www.freepascal.org), but you can use
  other compilers as GNU/Pascal (http://www.gnu.org), Delphi, MinGW32
  (http://www.mingw.org) or any of the GNU compilers (http://www.gnu.org).

  Once you have installed the compiler, unzip the file in a disk directory
  (i.e.: C:\Mingro).  Look for a directory named "lib" (i.e.: C:\Mingro\lib),
  and copy the "alleg42.dll" and "mingro.dll" files in a system directory
  (i.e.: C:\Windows\system32).

  Then get the "mingro.pas" file from the "lib" directory and copy it to the
  unit directory (i.e.: C:\FPC\units\rtl) or look for directory named "include"
  (i.e.: C:\Mingro\include) and copy its content to the "include" directory of
  of your compiler (i.e.: C:\MinGW\include).  if necesary, copy the
  "libmingro.a" file from the Mingro's "lib" directory to the compiler's "lib"
  directory (i.e.: C:\MinGW\lib).



==========
How to use
==========

  You have some simple examples in the "examples" directory
  (C:\Mingro\examples).  Read the "readme.txt" file on this directory to get
  a list of all the examples and a simple explanation.

  If you're usin C or C++ you shoul include the "mingro.h" file in your
  programs and also write "END_OF_MAIN()" after your "main" function.  Then
  link the program with libraries "-lmingro -lalleg" (NOTe: That means you'll
  need to install Allegro 4.2 in your system).

  The documentation is writen in Spanish.  If you can read Spanish and
  translate it to English, please send an e-mail to us.  (see the bottom of
  this file).



================
Release programs
================

  Do not forget to include the "mingro.dll" and "alleg42.dll" in the
  installation package or your programs wouldn't run at all!



===========
Help needed
===========

  The curren version is unfinished, a Work In Progres (WIP).  You can help to
  finish Mingro and add your name to the author's list.  We need people to test
  the library, to complete the documentation, to translate it to other
  languajes or to develop demos and examples.

  If you want to help, read the nex section and contact us!



============
Contact info
============

  We've reserved a space in sourceforge.net: http://mingro.sourceforge.net.
  The project summary is http://sourceforge.net/projects/mingro.

  You can send an e-mail to "niunio-at-users.sourceforge.net".

  We have a public forum at http://www.burdjia.com but it's an spanish site.

  uo visits the Allegro.cc forum (http://www.allegro.cc/forum) almost
  everyday.  His nick name is Niunio.

