Tidy repo #1

Closed

chris-ashford wants to merge 3 commits from main into main

chris-ashford commented

2024-05-22 00:53:33 +00:00

(Migrated from github.com)

Hiiii Hannaaaaaah,

This pull request doesn't change any of the actual code in your project, that's all yours. Instead, it just makes the repo slightly more friendly to the GitHub platform and for a member of the public to look at.

Why am I doing this:

To show you what a pull request is, if you didn't know. It's how you contribute to other people's repositories.
To make the repo look cleaner to other people
To increase the number of contributions on my account

What does this change:

Removes the pycache folder from the repository. pycache is platform dependant, it only works on your system and changes all the time. There's also a line in the newly created .gitignore file that prevents it from being uploaded again.
Change the README to markdown. This is just a minor file extension/formatting thing, it just changes the project's page to look much better on GitHub.
Add a requirements.txt file. This let's someone easily install the project's dependencies, and I've added instructions to the README.
I wanted to make a thing that made the testing automated, but the way you've integrated the GUI directly into the code means I can't import individual functions from the module without starting the GUI. So, I haven't done this because I would have to change the code, but it's something to consider if you wanna keep working on it.

I understand if you don't merge this, since it's your project, I get if you wanna be the sole contributor. Just some changes to consider (plus I get the credit on my profile just for submitting this even if you don't merge it :P)

- Kris

Hiiii Hannaaaaaah, This pull request doesn't change any of the actual code in your project, that's all yours. Instead, it just makes the repo slightly more friendly to the GitHub platform and for a member of the public to look at. Why am I doing this: - To show you what a pull request is, if you didn't know. It's how you contribute to other people's repositories. - To make the repo look cleaner to other people - To increase the number of contributions on my account What does this change: - Removes the pycache folder from the repository. pycache is platform dependant, it only works on your system and changes all the time. There's also a line in the newly created .gitignore file that prevents it from being uploaded again. - Change the README to markdown. This is just a minor file extension/formatting thing, it just changes the project's page to look much better on GitHub. - Add a requirements.txt file. This let's someone easily install the project's dependencies, and I've added instructions to the README. - I wanted to make a thing that made the testing automated, but the way you've integrated the GUI directly into the code means I can't import individual functions from the module without starting the GUI. So, I haven't done this because I would have to change the code, but it's something to consider if you wanna keep working on it. I understand if you don't merge this, since it's your project, I get if you wanna be the sole contributor. Just some changes to consider (plus I get the credit on my profile just for submitting this even if you don't merge it :P) \- Kris