From a5e9193217008897f928a81c93733d904aab7e9e Mon Sep 17 00:00:00 2001
From: LordBaryhobal <lordbaryhobal@gmail.com>
Date: Tue, 11 Jul 2023 18:46:35 +0200
Subject: [PATCH] added README

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

diff --git a/README.md b/README.md
index 9eaf8e9..658e30e 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,13 @@
 # XFTGenerator
+This Python script lets you generate boilerplate C state machines
 
+## Requirements
+- Python 3
+
+## Executing
+To run the program, execute `main.py`.
+Answer the questions to generate the files.
+The output will be located in `XFTGenerator/out/`.
+
+## License
+This software is provided under the GPL3.0 license
\ No newline at end of file