aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorA404M <ahmadmahmoudiprogrammer@gmail.com>2025-06-03 04:59:32 +0330
committerA404M <ahmadmahmoudiprogrammer@gmail.com>2025-06-03 04:59:32 +0330
commit7296f70ccb33fa7a2b34b0a0332bac7b93d21e0d (patch)
tree5659fc9518f6adac6fd7b967fe7a967d74001d36
parent61e50dd53ee56586fca31fcb8110bb566cc4d9f7 (diff)
add guid on how to compile
-rw-r--r--Makefile4
-rw-r--r--README.md24
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
```