Lots of different non-functional cleanups and improvements

[CrsiX]

Note that this should be merged after the GPL license has been accepted (issue #15, pull request #19)!

Changes introduced during this "clean-up" are:

• A rewritten README file with a improved structure, proper relative hyperlinks, a better description of the repository structure and simplified textual layout
• An updated CONTRIBUTING.md file that reflects changes in the README and minor grammar improvements
• Moving the pull request template from docs into .github (because it has actually nothing to do with the project's documentation, if we had one)
• Small extension to the issue template
• Removed the .project file which is only useful for the Eclipse IDE
• Edited the .gitignore file to include a bunch of other file types that should not find their way into this repository
• Renamed other files in the dedicated directories if they didn't meet the structure description
• Cleaned up the test environment of exercise 2 (a1de7b7)
• Cleaned up the test environment of exercise 3 (1aeb270)

If anyone has something in mind, feel free to comment on those proposed changes here or on Zulip :)

[JohannesStoehr]

You should probably exclude this in the .gitignore as well: https://en.wikipedia.org/wiki/.DS_Store
Well, to greet minds, one idea: #34

[babyygemperor]

As an idea, how about adding a .sh script which automatically clones this rep and copies the tests to the project folder?

[CrsiX]

As an idea, how about adding a .sh script which automatically clones this rep and copies the tests to the project folder?

Where's the benefit? The benefit of the current procedure of symlinks is: you set it up once (for one exercise) and it "just" works. Okay, you may update the test repository from time to time (git pull), but then all the tests are synchronized again. Adding a shell script brings no benefit in my opinion. Additionally, it adds unnecessary complexity and is error-prune due to the large number of different setups if you want to do something automatically. If you don't want to do it automatically, well, what should the script do then?

[CrsiX]

You should probably exclude this in the .gitignore as well: https://en.wikipedia.org/wiki/.DS_Store
Well, to greet minds, one idea: #34

Would you suggest to include desktop.ini as well? I'm not on Windows, therefore I'm not sure if this is a problem for Windows users or not.

[babyygemperor]

As an idea, how about adding a .sh script which automatically clones this rep and copies the tests to the project folder?

Where's the benefit? The benefit of the current procedure of symlinks is: you set it up once (for one exercise) and it "just" works. Okay, you may update the test repository from time to time (git pull), but then all the tests are synchronized again. Adding a shell script brings no benefit in my opinion. Additionally, it adds unnecessary complexity and is error-prune due to the large number of different setups if you want to do something automatically. If you don't want to do it automatically, well, what should the script do then?

Well, there wasn't really any benefit per se. I just thought it'd be nice to add multiple possibilities but then I've been reminded of https://xkcd.com/927/

[CrsiX]

Well, there wasn't really any benefit per se. I just thought it'd be nice to add multiple possibilities but then I've been reminded of https://xkcd.com/927/

I see ^^
You don't mind when we don't add some more or less shitty shell script (which apparently doesn't work cross-platform) to the repository? :)

[babyygemperor]

I see ^^
You don't mind when we don't add some more or less shitty shell script (which apparently doesn't work cross-platform) to the repository? :)

Not at all, was just a stupid idea. But in Hindsight, we could've also had integrated symlinks within the shell script with the default paths of the project directories, which would've definitely been helpful

[N0W0RK]

Sounds like some much needed maintanance that I have been avoiding :)

[babyygemperor]

Perfect

[CrsiX]

I will just close the PR. I've merged it into main but didn't pushed until now.