From e79ab46844c02ee029dfde4e6c2a6dface0e24d1 Mon Sep 17 00:00:00 2001
From: Hazem Krimi <krimihazem1@gmail.com>
Date: Tue, 23 Apr 2024 20:28:36 +0100
Subject: [PATCH] Update README.md

---
 README.md | 15 +++++++++++++--
 1 file changed, 13 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 6a2d198..2dfe709 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,13 @@
-# jack-vm-translator
-VM Translator from The Jack language VM code to The Hack language assembly code as part of the Nand to Tetris course
+# Jack VM Translator
+
+This is a VM Translator made as the an assignment for the [Nand To Tetris Course: Part 2](https://nand2tetris.org/project07). It assumes that the vm file file does not have errors for now.
+
+To compile the program run the following command:
+```
+g++ main.cpp -Isrc
+```
+To run the executable against jack vm files run the following command with the path of the file:
+```
+./a.out <path>
+```
+The file will be written next to the source file.