docs: add README for MASM codegen crate

0xPolygonMiden · Jul 12, 2023 · 0dd4501 · 0dd4501
1 parent ce823f9
commit 0dd4501
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/codegen/masm/README.md b/codegen/masm/README.md
@@ -0,0 +1,5 @@
+# Miden assembly code generator
+
+This crate contains a code generator targeting the [Miden VM](https://github.com/0xPolygonMiden/miden-vm).
+
+The purpose of this code generator is to convert a provided `AirIR` representation of an AIR into a custom Miden assembly module that contains constraint evaluation logic for this AIR. The generated code can be used with the recursive STARK proof verifier in Miden standard library.