GenI natural language generator (http://kowey.github.com/GenI)

root

Build Status

Documentation

  1. homepage and wiki
  2. manual
  3. API

Installing GenI

Command line interface and server

(tested on Linux, Windows, and MacOS X)

  1. Install the Haskell Platform. GenI 0.24 is known to build with either haskell-platform-2013.2.0.0 and haskell-platform-2012.2.0.0. Other versions may work too.

    If you want the graphical interface, and you are on a 64-bit Mac, take the 64-bit version of the Haskell Platform.

  2. Install the basic version first. If you just want the last stable release of GenI,

       cabal install GenI geniserver geni-util

    However, if you want to install the unstable version from source, change to the directory this README is in and

       cabal install . ./geniserver ./geni-util

Graphical interface

  1. Install wxWidgets. If you have a 64-bit Mac, install the Cocoa interface. If you use HomeBrew on Mac, brew install wxmac should do the trick.

    GenI 0.24 has been known to work with wxWidgets 2.9.4 on MacOS X, and is expected to work on wxWidgets 2.8.x or wxWidgets 2.9.x on Linux.

  2. Install wxHaskell (potentially painful)

       cabal install wx

    If you run into trouble here, you may need to use a development version of wxHaskell.

  3. Install the graphical interface (should be easy if 2 went well)

       cabal install ./geni-gui
  4. Try GenI (needs GenI examples files from this repository)

       cd examples/ej
       geni-gui -t trees -l lexicon -s suite

Development

I accept Darcs patches and GitHub pull requests. The Darcs repository might be a bit ahead of the Git one, but I'll try to keep the mirror up to date.

Style

Please follow published style guide. There is quite a bit of old code that does not follow this. Sorry. I'm slowly working on transitioning it.

Versions

  • Stable version has even minor number (eg. 0.22.x)
  • Development version has odd minor number (eg 0.23.yyyymmdd) Sometimes with a datestamp for major API changes in between
  • NEWS file will probably mention the next release (eg. 0.24)

Contact us!

Please let us know if you are using GenI; we'd like to hear about your experiences, both positive and negative.