Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dleiferives authored Nov 17, 2024
1 parent acba8fd commit 7813742
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,21 @@
## Mini language Implementation
## Minilang Implementation

CSC-431
Implemented for Cal Poly compiler design (CSC-431) Spring 2024.

### Features:
- Bespoke cache optimized AST for pratt parsing
- Supports both LLVM-IR and ArmV8 as backends
- "Impossible state Impossible" internal representation of IR
- Strongly controled mutability and creation
- Internal management for CFG and Basic Block transformation
- Large set of unit level tests and product level tests


## BUILD INSTRUCTIONS

### Setup

In Order to build the project zig version 0.11 must be installed.
In order to build the project zig version 0.11 *must* be installed.

There is a nix shell setup for the project that will get you into a shell with [`just`](https://github.com/casey/just) (an alternative to `make`), clang (llvm) v7.0.1, and the correct version of zig.
- If you have `nix` and `just` installed you can run `just nix` to get into a shell with the correct versions of everything installed
Expand Down

0 comments on commit 7813742

Please sign in to comment.