Readme for HaTeX-3.16.1.1

The HaTeX library

HaTeX is a Haskell library that implements the LaTeX syntax, plus some abstractions over it.

Check a list of usage examples in the Examples directory of the repository in GitHub. A good starting point may be simple.hs. Run any example script executing the main function.

Installation notes

To install HaTeX, use cabal-install.

$ cabal update
$ cabal install HaTeX

This will download and install the latest official release (recommended). If you want to try a newer version, use git to clone the code contained in this repository.

$ git clone git@github.com:Daniel-Diaz/HaTeX.git
$ cd HaTeX
$ cabal install

However, note that the API may be unstable and is subject to any kind of change. In the other hand, this package follows the Package Versioning Policy, so it is unlikely to suffer from API breakages if you follow it too when importing the library (assuming you are using the version in Hackage).

See the Hackage page of HaTeX to browse older versions.

HaTeX User's Guide

The HaTeX User's Guide lives here... and is also done in Haskell! It is free source and anybody can contribute to it. Doing so, you will help current and future users!

A downloadable version (not necessarily the last version, but most likely) can be found here. To be sure that you are reading the last version, go to the github repository of the guide and follow instructions to build it. It is fairly easy.

Please note that the user's guide needs to be updated (contributions are more than welcome!).

Community and Contributions

There are many ways to get involved in the HaTeX project. Use the most comfortable way for you.

TODO list

Travis automatic build

Every time code changes in the GitHub repository, an automatic build checks that the library compiles with several versions of GHC (7.4, 7.6, and 7.8) and that all tests pass. This label indicates the result of the last automatic build.

Build Status

Currently, automatic builds are only running under Linux. We hope Travis will support other systems in the future.