From 497bd5144e17eca61b8c73fb73b7354e7955e842 Mon Sep 17 00:00:00 2001
From: Timerix22 <timerix11@gmail.com>
Date: Wed, 29 Mar 2023 22:25:35 +0600
Subject: [PATCH] README.md

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e114994
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# GraphC - visual programming tool
+When i was working on my compiler project, i understood that AST processing code isn't clear even for me because of hundreds lines of condition branches. GraphC is GUI editor of condition trees. It generates optimized AST processing code in C. 
+GUI is based on [Dear ImGui](https://github.com/ocornut/imgui) and [SDL](https://github.com/libsdl-org/sdlwiki)
+
+
+## Installation
+1. Clone the repository
+```shell
+git clone --recurse-submodules https://github.com/Timerix22/GraphC
+```
+2. Install **SDL2** from package manager or compile it from source (read [SDL docs](SDL/docs/README.md)).  
+3. Compile the program
+```shell
+make build_exec
+```
+4. Copy program files from `bin/*` to any directory