Update README.md

README.md

@@ -1,2 +1,30 @@
-# code-status
-Project to calculate how many lines of code has be written and in which langauges
+# Code Status
+
+Simple project to calculate how many lines of code has be written and in which langauges.
+
+Main idea is to create a GUI to easily filter/ignore or include files and extensions.
+
+Further details will be written soon...
+
+## License
+
+This project is licensed under the [GNU GPL-3.0](https://github.com/ErtyumPX/code-status/blob/main/LICENSE) license.
+
+## Setup
+
+Project is currently compiled with GNU G++ 13.2.1.
+
+There is no third-party dependency.
+
+For compiling and linking rules GNU Make 4.4.1 was used.
+
+After fulfilling dependencies, download or clone the project and use Makefile to easily compile:
+
+```
+> make all
+> make run
+```
+
+## Project
+
+-- will be added as the project developes --