vishapoberon/compiler
1
0
Fork 0
mirror of https://github.com/vishapoberon/compiler.git synced 2026-04-05 23:22:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Some more significant ReadMe work.

Browse source
This commit is contained in:
David C W Brown 2016-06-27 15:53:36 +01:00
parent a359e16ae9
commit b495b2725c
15 changed files with 148 additions and 2997 deletions
Download patch file Download diff file Expand all files Collapse all files

69
ReadMe.md
View file

@ -10,7 +10,12 @@ orders of magnitude smaller than found in contemporary systems.
implementation of the Oberon-2 language compiler and libraries for use on
current operating systems such as Linux, BSD, Android, Mac and Windows.
The language is an evolution of the Pascal and Modula languages, following the
Vishap's Oberon Compiler (voc) uses a C backend to compile
Oberon programs under Unix or Windows. Vishap Oberon includes
libraries from the Ulm, oo2c and Ofront Oberon compilers, as well as
default libraries complying with the Oakwood Guidelines for Oberon-2 compilers.
The Oberon language is an evolution of the Pascal and Modula languages, following the
principals of Einstein and Antoine de Saint-Exupéry:
> Make it as simple as possible, but not simpler. (A. Einstein)
@ -19,6 +24,60 @@ principals of Einstein and Antoine de Saint-Exupéry:
> when there is no longer anything to take away. (Antoine de Saint-Exupéry,
> Terre des Hommes, 1939, translated by Lewis Galantière.)
#### Installation
1. `git clone https://github.com/vishaps/voc`
2. `cd voc`
3. `[sudo] make full`
Since 'make full' will install the compiler and libraries, it needs root (unix) or administrator (windows) privileges.
Then set your path to the installed compiler binary location as reported
by make full, e.g.
| System | Set path |
| --------- | -------------------------------------- |
| Linux | `export PATH="/opt/voc/bin:$PATH"` |
| BSD | `export PATH="/usr/local/share/voc/bin:$PATH"` |
| Windows | See [Installation](/doc/Installation.md) |
| Termux | `export PATH="/data/data/com.termux/files/opt/voc/bin:$PATH"` |
Also see [Installation](/doc/Installation.md).
#### A 'Hello' application
Anything appended to Oberon.Log is automatically displayed on the console, so the
following conventional Oberon program will display 'Hello.':
MODULE hello;
IMPORT Oberon, Texts;
VAR W: Texts.Writer;
BEGIN
Texts.OpenWriter(W);
Texts.WriteString(W, "Hello."); Texts.WriteLn(W);
Texts.Append(Oberon.Log, W.buf)
END hello.
Alternatively the Console may be accessed directly as follows:
MODULE hello;
IMPORT Console;
BEGIN
Console.String("Hello."); Console.Ln;
END hello.
Compile as follows:
voc hello.mod -m
The -m parameter tells voc that this is a main module, and to generate an
executable binary.
Execute as usual on Linux ('./hello') or Windows ('hello').
Also see [Compiling](/doc/Compiling.md).
#### Licensing
Vishap Oberon's frontend and C backend engine is a fork of Josef Templ’s Ofront, which has been released
@ -65,14 +124,6 @@ Some other freely redistributable libraries are available as a part of voc distr
See [Features](/doc/Features.md).
#### Installation
See [Installation](/doc/Installation.md).
#### Compiling Oberon modules
See [Compiling](/doc/Compiling.md).
#### Porting to new platforms
See [Porting](/doc/Porting.md).