phadej / hscurses Goto Github PK

               hscurses -- A Haskell Binding to ncurses
               =+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+

hscurses is a Haskell binding to the ncurses library, a library of
functions that manage an application's display on character-cell
terminals. hscurses also provides some basic widgets implemented on
top of the ncurses binding, such as a text input widget and a table
widget.

The hscurses library has been reported to work on Linux x86 using GHC
6.12.1, 7.0.3 and 7.2.1.

Building and installing the hscurses library with GHC
-----------------------------------------------------

Requirements:

- GNU m4
- GHC >= 6.8
- ncurses

Build and installation steps:

  runhaskell Setup.hs configure
  runhaskell Setup.hs build
  runhaskell Setup.hs install

In order to generate the API documentation, you need haddock
(http://www.haskell.org/haddock). The command is then:

  runhaskell Setup.hs haddock

Using the hscurses library:
---------------------------

Just add the flag `-package hscurses' to the compiler flags. At the
moment, user documentation is only available through Haddock API
documentation.

Windows support:
----------------

Windows support relies on pdcurses (http://pdcurses.sourceforge.net/),
which is already packaged for MinGW
(http://sourceforge.net/projects/mingw/files/MinGW/PDCurses/PDCurses-3.4-1/)
and can be installed with mingw-get.

Thanks to José Romildo Malaquias ([email protected]) for porting
hscurses to the windows platform!

There is also a detailed installation instruction by Ilan Godik 
(https://medium.com/@NightRa): 
https://medium.com/@NightRa/installing-hscurses-on-windows-830532d3268a

Copyright:
----------

   John Meacham <john @ repetae . net>, 2002-2004.
   Tuomo Valkonen <tuomov @ iki.fi>, 2004.
   Don Stewart <http://www.cse.unsw.edu.au/~dons>, 2004.
   Stefan Wehr <http://www.stefanwehr.de>, 2004-2011.

History:
--------

John Meacham started the binding for his chat client Ginsu
(http://repetae.net/john/computer/ginsu/).

Tuomo Valkonen integrated to code into Riot
(http://modeemi.fi/~tuomov/riot/), with minor modifications.

Don Stewart improved the code for the Yi editor
(http://www.cse.unsw.edu.au/~dons/yi.html).

Stefan Wehr turned the binding into a standalone library. He also
added some basic widgets.