README

PHP Ncurses
===========

**ATENTION**: THIS IS A DEPRECATED PACKAGE. USE [STENCIL] INSTEAD.

[STENCIL]: https://github.com/guide42/stencil

---

This is an interface for Ncurses PHP extension. Is highly object-oriented by
design and brings new concepts to the ncurses world.

Requirements
------------

The ncurses library and the ncurses PHP extension witch is included in the core
from PHP >= 4.0.7 to PHP < 5.3.0 and from there as a PECL extension.

You can install it runing this (as root)::

    $ pecl install ncurses

And then you need to enable the extension in your *php.ini* by adding::

    extension=ncurses.so

PHPUnit is needed for running the test suite.

Core Concepts
-------------

The core class is ``\Ncurses\Ncurses`` that is needed to be instanced for
everything to work. It contains several methods to be applied to the standard
screen (the whole application) and an unique instance of the event queue.