From 7296f70ccb33fa7a2b34b0a0332bac7b93d21e0d Mon Sep 17 00:00:00 2001
From: A404M <ahmadmahmoudiprogrammer@gmail.com>
Date: Tue, 3 Jun 2025 04:59:32 +0330
Subject: add guid on how to compile

---
 Makefile  |  4 ++--
 README.md | 24 ++++++++++++++++++++++++
 2 files changed, 26 insertions(+), 2 deletions(-)

diff --git a/Makefile b/Makefile
index d713229..0fd74c4 100644
--- a/Makefile
+++ b/Makefile
@@ -20,9 +20,9 @@ INC_DIRS := $(SRC_DIR)
 INC_FLAGS := $(addprefix -I,$(INC_DIRS))
 
 # OP_FLAG := -Ofast
-# OP_FLAG := -O3
+OP_FLAG := -O3
 # OP_FLAG := -Oz
-OP_FLAG := -g
+# OP_FLAG := -g
 
 LINK_FLAGS := -lffi
 
diff --git a/README.md b/README.md
index 23d8e40..ae9dd84 100644
--- a/README.md
+++ b/README.md
@@ -7,10 +7,34 @@ A strongly statically typed programming language with a simple and friendly synt
 * Operator overloading
 * Function overloading
 * Generic programming
+* Meta programming
 * Low level access
 * Pointer
 * ...
 
+# Requirement
+* Linux or *nix like OS
+* git
+* gnu make
+* gcc (you can use clang or tcc but you have to change make for it)
+* libffi (for calling C functions)
+
+# How to use ?
+## Clone the repo
+```
+git clone https://github.com/A404M/felan
+cd felan
+```
+## Building
+```
+make
+```
+## Running
+Run ./build/felan with any file which you want to run
+```
+./build/felan code/main.felan
+```
+
 # Examples
 ## Hello world
 ```
-- 
cgit v1.2.3