Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Missing Readme & restructure /Includes/ #32

Open
1 of 2 tasks
Teufelchen1 opened this issue Feb 16, 2020 · 1 comment
Open
1 of 2 tasks

Documentation: Missing Readme & restructure /Includes/ #32

Teufelchen1 opened this issue Feb 16, 2020 · 1 comment

Comments

@Teufelchen1
Copy link
Contributor

Teufelchen1 commented Feb 16, 2020

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.

  • Add a README
  • Restructure code

😇✨

@Teufelchen1 Teufelchen1 mentioned this issue May 2, 2020
4 tasks
@Teufelchen1
Copy link
Contributor Author

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.

@Teufelchen1 Teufelchen1 changed the title Documentation: Missing Readme Documentation: Missing Readme & restructure /Includes/ May 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant