charlesap / obnc Goto Github PK

INTRODUCTION

OBNC is a compiler for Niklaus Wirth's programming language Oberon. It translates Oberon modules into C code. The build command (obnc) invokes both the Oberon compiler (obnc-compile) and the host C compiler and sorts out all dependencies.

OBNC follows POSIX standard. This implies that it should compile and run on a POSIX compatible operating system.


INSTALLATION

1. Make sure you have Boehm-Demers-Weiser's garbage collector GC installed on your system. To use the basic library modules Input and XYplane you also need SDL (Simple DirectMedia Layer). On a Debian system you install these dependencies with the command

	apt install libgc-dev libsdl1.2-dev

2. Compile OBNC with the command

	./build

By default OBNC is built to be installed in /usr/local. If you want to use installation directory D instead, add `--prefix=D' to the build command. For other build options, run `./build -h'.

3. Optionally, run unit tests with the command

	./test

4. Install OBNC with the command

	./install

To undo the installation, run `./install u'. For other installation options, run `./install -h'.


COMMANDS

bin/obnc
	Oberon build tool

bin/obnc-compile
	Oberon-to-C compiler

bin/obnc-path
	Oberon module finder

bin/obncdoc
	Oberon documentation generator


DOCUMENTATION

share/doc/obnc/oberon-report.html
	Oberon language reference

share/doc/obnc/obncdoc/obnc
	Basic library modules

share/man/man1/
	OBNC commands


LICENSE

OBNC is released under the GNU General Public License (see file COPYING), with the exception of library source files in lib/obnc which are released under the Mozilla Public License (see file lib/obnc/LICENSE).


AUTHOR

Karl Landstrom <[email protected]>