STALLioN Terminal I/O Library Files

/*	STALLioN - Cross-platform terminal input-output library
    Copyright (C) 2012  Daniel Mansfield <daniel.mansfield99@gmail.com>

    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 3 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
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

 ------------
|Version 0.20|
 ------------

What is it?
==========

STALLioN is a cross-platform C/C++ library for developers wishing to use a
terminal/CLI interface on multiple platforms but only want a single codebase.

It aims to provide a consistent development API across multiple platforms so that
separate code does not have to be created for each (often very different)
terminal interface; simply use the functions in STALLioN and compile with the
correct library for the chosen platform.

It is licensed under the GPLv3 license, so is free software.

Available Platforms
====================

STALLioN is know to currently run on Windows, Linux and FreeBSD. All 3 of these
have binary releases available.

Using STALLioN
==============

To use STALLioN in your projects you need to simply write your program using
the STALLioN API and then link the correct library for your platform when
compiling. STALLioN does not need to be compiled along with your program, and
you do not have to distribute it alongside it either since it is a static library.
Once compiled, STALLioN's functions should functions as expected on any computer
of the same platform.

For an in-depth guide see the file doc/manual.txt which should have been included
with the library.

Note
====

I cannot vouch for the current capabilities of STALLioN in a production
environment! It is not yet at the stable release stage, and so there may be many
not yet found bugs. It should be usable in the most part however, and the syntax
of current functions is not likely to change much, so any programs writen using
it are unlikely to break after an update.