From 27195ec717f142b9d84cba5fc136ed646660c2f5 Mon Sep 17 00:00:00 2001
From: Hazem Krimi <krimihazem1@gmail.com>
Date: Mon, 18 Mar 2024 05:09:44 +0100
Subject: [PATCH] Create README.md

---
 README.md | 9 +++++++++
 1 file changed, 9 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cf3c564
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+# Hack Assembler
+
+This is an assembler made as the final assignment for the [Nand To Tetris Course: Part 1](https://nand2tetris.org/project06). It assumes that the assembly file does not have errors for now.
+
+To run this against hack assembly files clone this repo and run the following command with the path of the file:
+```
+cargo run <path>
+```
+The file will be written next to the source file.