Dekejit/README.md

# DEKEJIT

## EXPERIMENTAL!! NOTHING WORKS AND MAKES SENSE!!!

This is an experimental 16-bit virtual machine.

A lenghty description can be found [here.](spec.md)

If you want to have a great time, you can try experimenting with it:

### Installation

To install the program, run `cargo install --path .` .

This currently builds the virtual machine, which can execute binary files, and an assembler which can turn text files into binary files.

### Usage

`dekejit build <assemby_file> <output_file>` will read the provided `<assembly_file>` and write a binary file `<output_file>` which can be executed using `dekejit run <binary_file>`

A few example files can be found in `tests/assembly/`. 


### Future

Right now the only possible way to use the virtual machine is to manually write the assembly.
In the future, small compilers for toy languages will be built that target my toy assembly.