added README.md

some code clean up

1 files changed, 37 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d0016ee
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# FELan
+
+A new programming language
+
+# How to use
+
+TO compile just run
+```sh
+./project compile
+```
+It would make an executable as `./build/felan`
+
+Or you can compile and run with
+```sh
+./project run
+```
+Just like compile, it would make an executable as `./build/felan`
+
+To run code just send your source file to the program like
+```sh
+felan some_path.felan
+# or
+./project run some_path.felan
+```
+
+# Examples
+
+To print `Hello` with no new line
+```felan
+print("Hello")
+```
+
+To print `Hello` with a new line
+```felan
+print("Hello\n")
+```
+