From d8d49997282ba011e6b5c62579b44ff00a24f660 Mon Sep 17 00:00:00 2001
From: Hazem Krimi <me@hazemkrimi.tech>
Date: Fri, 17 Apr 2026 12:30:56 +0100
Subject: [PATCH] chore: update readme

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/README.md b/README.md
index 28b5657..a3622dd 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,33 @@
 # Jack Compiler
 
 Compiler from The Jack language to The Hack platform (Nand2Tetris Part 2)
+
+## Requirements
+
+You need Go to develop, build, and run this project.
+
+## Installation
+
+1. Clone this repo:
+
+```
+git clone https://github.com/hazemKrimi/jack-compiler
+```
+
+2. To run this against Jack files, run the following command with the path of the `.jack` file (or directory):
+
+```
+./out/jack-compiler <path_to_jack_file_or_directory>
+```
+
+The result `.vm` file will be written in the same location as the source file.
+
+## Build
+
+- To build this project run the following command:
+
+```
+go build -o out
+```
+
+You will find the executable in the `out` directory.