Shorthand

This repository contains information about a simple virtual instruction set, tools and tests for exploring it, and implementations of simple virtual machines for running programs that use it.

Documentation

To build the documentation for this project on Linux/Unix systems, run the tools/makedocs.sh script from the repository root, like this:

./tools/makedocs.sh

This should produce an html directory that contains an HTML version of this document and a collection of documents about the project.

Information about the design of the instruction set and its encoding can be found in the instructions document.

Tools

The following tools are provided in the tools directory:

assembler.py is the assembler for the instruction set.
simulator.py is the simulator for running programs encoded using the instruction set.
makedocs.sh builds the documentation for this project.

Additional tools are supplied in subdirectories. The compressed directory contains a script that one of the tests requires.

Tests

The tests directory contains resources related to tests and testing. These are described in the tests document.

License

The software included in this repository, unless otherwise specified, is licensed under the GNU General Public License version 3 or later:

Copyright (C) 2023 David Boddie <david@boddie.org.uk>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

See the COPYING file for more information about the license.