u6a/README.md

# u6a

[![Travis CI](https://travis-ci.com/esolangs/u6a.svg)](https://travis-ci.com/esolangs/u6a)
[![Codecov](https://codecov.io/gh/esolangs/u6a/branch/master/graphs/badge.svg)](https://codecov.io/gh/esolangs/u6a)
[![LICENSE](https://img.shields.io/badge/licence-GPLv3-blue.svg)](LICENSE)

Implementation of Unlambda, an esoteric programming language.

## Description

The u6a project provides a bytecode compiler and a runtime system for the [Unlambda](http://www.madore.org/~david/programs/unlambda/) programming language.

Ideas behind this implementation can be found [here](https://github.com/esolangs/u6a/wiki/Developer's-Notes-on-Implementing-Unlambda).

## Getting Started

Building:

```bash
# (If not already) Install the required build tools.
sudo apt install build-essential automake
# (If you want to run tests) Install DejaGnu.
sudo apt install dejagnu
# Generate configuration script.
autoreconf --install
# Execute configuration script with desired options.
./configure --prefix=$HOME
# Compile source code and generate executables.
make
# (Optional) Run tests.
make check
# (Optional) Install executables and man pages.
make install
```

Usage:

```bash
# Compile an Unlambda source file into bytecode.
u6ac -o foo.unl.bc foo.unl
# Execute the bytecode file.
u6a foo.unl.bc
```

See [**u6ac**(1)](man/u6ac.1) and [**u6a**(1)](man/u6a.1) man pages for details.

## Future Plans

* Interactive debugger: `u6adb`
* More compile-time optimizations
* More test cases
* LLVM backend for `u6ac`
initial commit 2020-01-30 10:11:10 +00:00			`# u6a`

fix links 2020-05-24 18:56:39 +00:00			`[![Travis CI](https://travis-ci.com/esolangs/u6a.svg)](https://travis-ci.com/esolangs/u6a)`
			`[![Codecov](https://codecov.io/gh/esolangs/u6a/branch/master/graphs/badge.svg)](https://codecov.io/gh/esolangs/u6a)`
update 2020-02-02 17:09:21 +00:00			`[![LICENSE](https://img.shields.io/badge/licence-GPLv3-blue.svg)](LICENSE)`
initial commit 2020-01-30 10:11:10 +00:00
			`Implementation of Unlambda, an esoteric programming language.`

			`## Description`

update 2020-02-01 14:45:48 +00:00			`The u6a project provides a bytecode compiler and a runtime system for the [Unlambda](http://www.madore.org/~david/programs/unlambda/) programming language.`
initial commit 2020-01-30 10:11:10 +00:00
fix links 2020-05-24 18:56:39 +00:00			`Ideas behind this implementation can be found [here](https://github.com/esolangs/u6a/wiki/Developer's-Notes-on-Implementing-Unlambda).`
initial commit 2020-01-30 10:11:10 +00:00
update 2020-02-01 14:45:48 +00:00			`## Getting Started`
initial commit 2020-01-30 10:11:10 +00:00
update 2020-02-01 14:45:48 +00:00			`Building:`
initial commit 2020-01-30 10:11:10 +00:00
			```bash
			`# (If not already) Install the required build tools.`
			`sudo apt install build-essential automake`
add test cases 2020-03-14 20:31:20 +00:00			`# (If you want to run tests) Install DejaGnu.`
			`sudo apt install dejagnu`
update 2020-02-01 14:45:48 +00:00			`# Generate configuration script.`
initial commit 2020-01-30 10:11:10 +00:00			`autoreconf --install`
update 2020-02-01 14:45:48 +00:00			`# Execute configuration script with desired options.`
initial commit 2020-01-30 10:11:10 +00:00			`./configure --prefix=$HOME`
update 2020-02-01 14:45:48 +00:00			`# Compile source code and generate executables.`
initial commit 2020-01-30 10:11:10 +00:00			`make`
			`# (Optional) Run tests.`
			`make check`
			`# (Optional) Install executables and man pages.`
			`make install`
			```

update 2020-02-01 14:45:48 +00:00			`Usage:`
initial commit 2020-01-30 10:11:10 +00:00
			```bash
update 2020-02-01 14:45:48 +00:00			`# Compile an Unlambda source file into bytecode.`
initial commit 2020-01-30 10:11:10 +00:00			`u6ac -o foo.unl.bc foo.unl`
update 2020-02-08 16:51:31 +00:00			`# Execute the bytecode file.`
initial commit 2020-01-30 10:11:10 +00:00			`u6a foo.unl.bc`
			```

			`See [u6ac(1)](man/u6ac.1) and [u6a(1)](man/u6a.1) man pages for details.`

update 2020-02-01 14:45:48 +00:00			`## Future Plans`
initial commit 2020-01-30 10:11:10 +00:00
update 2020-02-01 14:45:48 +00:00			* Interactive debugger: `u6adb`
initial commit 2020-01-30 10:11:10 +00:00			`* More compile-time optimizations`
update 2020-02-01 14:45:48 +00:00			`* More test cases`
			* LLVM backend for `u6ac`