Documentation: Missing Readme & restructure /Includes/

Open Teufelchen1 opened this issue 5 years ago • 1 comments

Hi,

a short readme about the project would be nice. I.e. What is this? How do install the dependencys if there are any? How do I build this software? How do I run it? Edit: In addition, its cool to restructure the code a bit for better readability.

[x] Add a README
[ ] Restructure code

😇✨

Feb 16 '20 09:02 Teufelchen1

Thinking of documentation, I wondered if it would be cool to split /includes/ into subdirectories. NevolutionX will grow and the folder is already crowded. There is not technical reason for further subdivision but I feel like it would improve the look & feel of the code base. Also, one could give a code overview in the README and would not have to reference files but subdirectories instead.

May 02 '20 17:05 Teufelchen1