i281 Assembler

This is the repository for the rust i281 assembler which is an assembler suite for the i281 CPU. It uses a parser-combinator strategy to parse the assembly language into an AST (Abstract Syntax Tree). After which it sends the AST to an analyzer that checks for correctness and creates a much simpler IR (Intermediate Representation) wich has a lot of the uneccessary data trimmed out of it. Then the compiler will take that IR and write it out in verilog format.

Project structure

The project is structured into several components:

Abstract Syntax Tree / Parser
Intermediate Representation
Analysis / Compilation functions
Command Line Interface

The separation of these components makes the compiler more pluggable for using in other rust projects / partial compilation. There may be goals of making a crate that is a web assembly library for use in web or other languages / projects.

How to use

First check the github releases page for pre-compiled binaries of the compiler for your os, or compile from source
Once you have an executable you can run compile281 --help to get a list of options for the compiler command
To compile an assembly project run compile281 [YOUR ASSEMBLY FILE] and the results will be in the ./build/ directory

Compiling From Source

Make sure you have rust installed.
Clone the repo to your local machine or unzip it from the archive
Run cargo build --release in the project directory
Your compiled binary will be located in target/release/compile281

Other Info

To run unit tests use cargo test --workspace to run all tests within the workspace
The examples directory has as many assembly examples as I had access to
Use cargo-deny to make sure all libraries used are MIT licensed

Libraries used and reasons