Introduction
============

The libt3highlight library provides functions for syntax highlighting different
types of text files.

libt3highlight is part of the Tilde Terminal Toolkit (T3)
[https://os.ghalkes.nl/t3/]

libt3highlight is licensed under the GNU General Public License version 3. See
the file COPYING for details.


Documentation
=============

The full documentation for libt3highlight can be generated using doxygen. The
documentation for the current version can be found at
https://os.ghalkes.nl/doc/libt3highlight.


Prerequisites and installation
==============================

libt3highlight requires the GNU libtool utility to be compiled. Furthermore, it
requires libpcre2 (or libpcre) and libt3config (version 0.2.0 or higher).

There are two ways in which to compile libt3highlight:

Using the configure script:
---

$ ./configure
or
$ ./configure --prefix=/usr
(see ./configure --help for more tuning options)
$ make all
$ make install
(assumes working install program)

Manually editing the Makefile to suit your computer:
---

$ cp Makefile.in Makefile

Edit the values for the different variables, using the comments in the
Makefile for guidance, to suit your environment.

$ make all
$ make install
(assumes working install program)

The Makefiles in the distribution should work on all POSIX compatible make's.
They have been tested using both GNU make and BSD make.


Reporting bugs
==============

If you think you have found a bug, please check that you are using the latest
version of libt3highlight [https://os.ghalkes.nl/t3/libt3highlight.html]. When
reporting bugs, please include a minimal example that demonstrates the problem.


Author
======

Gertjan Halkes <libt3highlight@ghalkes.nl>
