README

Ontology Toolchain
==================

The ontology toolchain (ontc) is a set of software development tools.
It uses ontologies to support the development of software.

Build
-----

The following software is used to build ontc:

 * GCC 10.2.0 (https://gcc.gnu.org/)
 * GNU Make 4.3 (https://www.gnu.org/software/make/)
 * GNU Bison 3.7.2 (https://www.gnu.org/software/bison/)
 * flex 2.6.4 (https://github.com/westes/flex)

All software versions mentioned above are no minimum versions but
recommendations because ontc can be successfully compiled using
these versions.

In order to build ontc just run:

	mkdir build
	make

The binary will be located in the build/ directory.

Documentation
-------------

The documentation is located at doc/.
It can be built using Doxygen (https://www.doxygen.nl/).

Just run:

	doxygen

in the doc/ directory. An HTML and LaTeX version will then be
generated.

License
-------

The ontology toolchain is made up of several components.

The two libraries libontg and liboxpl are licensed under the
GNU LGPL 2.1 (or later).
The source code of both libraries can be found at lib/ and include/.
For more information please see COPYING.LESSER.

The ontc command line tool is licensed under the GNU GPLv3 (or later).
Its source code can be found under src/.
For more information please see COPYING.

Every source code file contains an SPDX license identifier which specifies
the exact license of that source code file. See https://spdx.org/ for
the specification of the SPDX license identifier format.