swap around READMEs

Author: KTrain5169

.github/README.md

@@ -1,50 +1,44 @@
 # PythonTemplateRepo
 
-![Made in Python badge](../images/made-in-python.svg)
+Template repo for getting started with a Python project.
 
-This is a basic README template. Feel free to customise it to your liking.
+## Getting started
 
-## Features
+To get started, click on the `Use this template` at the top-right of the screen, then enter your project's name and any other info you want.
 
-- Feature 1
-- Feature 2
+You might see that some GitHub Actions runs will fail. This is normal. After some tweaking to them, they will work as your expect them to be, but you can choose to deal with that once you're all done.
 
-[See the documentation](../docs/) for more.
+## Directories
 
-## Options to run
+### docs/
 
-You can run the program from source or use a pre-compiled binary.
+The `docs` directory is the documentation folder. In Python, we can use `MkDocs` to make easy documentation without having to spend time on making a fancy site. MkDocs uses Markdown (.md) files placed in the `docs` directory to output a site that can be used as your documentation site for your program. It has many themes and plugins that you can choose from; though beware that to install those themes, you will have to install their libraries akin to running the author's code.
 
-Pre-compiled binaries are available either from the Releases tab (if the developer chooses to add them there) or after each push from the Actions tab (GitHub account required). Please be aware that using binaries from the Actions tab is very dangerous, as it is considered untested software.
+For more information, [visit MkDocs' website](https://www.mkdocs.org/).
 
-To run the program from source, you'll need to have the following prerequisites:
+### tests/
 
-- Python 3.11 <!-- Change this to the version of Python this is being developed in -->
-- Git (note that this is not a necessary but it's often best to have such)
+The `tests` directory is the unit tests folder, where all your unit tests will go. In Python, we can use `pytest` to have our code tested before setting it for production. You can ad tests by creating a folder named `test_` and then your script's name, for example, `test_main`. Inside, place a blank `__init__.py` file to let Python know that this is a module, and then you can run `pytest` in your terminal and see if your tests have passed or failed.
 
-- Clone this repository using:
+For more information on Pytest, [visit Pytest's docs](https://docs.pytest.org/en/stable/).
 
-```bash
-git clone https://github.com/{username}/{repo}
-```
+To learn about test-driven development, [Wikipedia is a good starting point](https://en.wikipedia.org/wiki/Test-driven_development)
 
-- Then, setup a virtual environment:
+### images/
 
-```bash
-python -m venv venv
-venv\scripts\activate
-pip install -r requirements.txt
-```
+The `images` directory is where you can store images you want to use. You can have app icons, badges, anything that has an image into that folder.
 
-- Finally, run the necessary command for your situation:
+### .vscode/
 
-```bash
-# Running the program itself
-python main.py
-# Viewing the MkDocs site
-mkdocs serve
-# Freezing the application
-pyinstaller --onefile main.py
-```
+The `.vscode` folder contains stuff that can only be used in Visual Studio Code (and any forks of its kind). This includes:
 
-And all done!
+- `/extensions.json` - Recommended VSCode extensions to use.
+- `launch.json` - Debug launch configs for VSCode.
+
+### .github/
+
+The `.github` folder contains GitHub-related stuff, such as:
+
+- `/workflows` - GitHub Actions workflow files that tells GitHub's runners how to behave on certain events.
+- `/dependabot.yml` - Dependabot's configuration file, which tells it what to update and how/where. [Learn more about Dependabot](https://docs.github.com/en/code-security/dependabot/working-with-dependabot).
+- `/README.md` - not actually something specific to GitHub, but it's an actual README file that you're welcome to take and adapt for your own project, to use over this README file. Remember to delete this after you fork the repo and start making changes!

README.md

@@ -1,44 +1,50 @@
 # PythonTemplateRepo
 
-Template repo for getting started with a Python project.
+![Made in Python badge](../images/made-in-python.svg)
 
-## Getting started
+This is a basic README template. Feel free to customise it to your liking.
 
-To get started, click on the `Use this template` at the top-right of the screen, then enter your project's name and any other info you want.
+## Features
 
-You might see that some GitHub Actions runs will fail. This is normal. After some tweaking to them, they will work as your expect them to be, but you can choose to deal with that once you're all done.
+- Feature 1
+- Feature 2
 
-## Directories
+[See the documentation](../docs/) for more.
 
-### docs/
+## Options to run
 
-The `docs` directory is the documentation folder. In Python, we can use `MkDocs` to make easy documentation without having to spend time on making a fancy site. MkDocs uses Markdown (.md) files placed in the `docs` directory to output a site that can be used as your documentation site for your program. It has many themes and plugins that you can choose from; though beware that to install those themes, you will have to install their libraries akin to running the author's code.
+You can run the program from source or use a pre-compiled binary.
 
-For more information, [visit MkDocs' website](https://www.mkdocs.org/).
+Pre-compiled binaries are available either from the Releases tab (if the developer chooses to add them there) or after each push from the Actions tab (GitHub account required). Please be aware that using binaries from the Actions tab is very dangerous, as it is considered untested software.
 
-### tests/
+To run the program from source, you'll need to have the following prerequisites:
 
-The `tests` directory is the unit tests folder, where all your unit tests will go. In Python, we can use `pytest` to have our code tested before setting it for production. You can ad tests by creating a folder named `test_` and then your script's name, for example, `test_main`. Inside, place a blank `__init__.py` file to let Python know that this is a module, and then you can run `pytest` in your terminal and see if your tests have passed or failed.
+- Python 3.11 <!-- Change this to the version of Python this is being developed in -->
+- Git (note that this is not a necessary but it's often best to have such)
 
-For more information on Pytest, [visit Pytest's docs](https://docs.pytest.org/en/stable/).
+- Clone this repository using:
 
-To learn about test-driven development, [Wikipedia is a good starting point](https://en.wikipedia.org/wiki/Test-driven_development)
+```bash
+git clone https://github.com/{username}/{repo}
+```
 
-### images/
+- Then, setup a virtual environment:
 
-The `images` directory is where you can store images you want to use. You can have app icons, badges, anything that has an image into that folder.
+```bash
+python -m venv venv
+venv\scripts\activate
+pip install -r requirements.txt
+```
 
-### .vscode/
+- Finally, run the necessary command for your situation:
 
-The `.vscode` folder contains stuff that can only be used in Visual Studio Code (and any forks of its kind). This includes:
+```bash
+# Running the program itself
+python main.py
+# Viewing the MkDocs site
+mkdocs serve
+# Freezing the application
+pyinstaller --onefile main.py
+```
 
-- `/extensions.json` - Recommended VSCode extensions to use.
-- `launch.json` - Debug launch configs for VSCode.
-
-### .github/
-
-The `.github` folder contains GitHub-related stuff, such as:
-
-- `/workflows` - GitHub Actions workflow files that tells GitHub's runners how to behave on certain events.
-- `/dependabot.yml` - Dependabot's configuration file, which tells it what to update and how/where. [Learn more about Dependabot](https://docs.github.com/en/code-security/dependabot/working-with-dependabot).
-- `/README.md` - not actually something specific to GitHub, but it's an actual README file that you're welcome to take and adapt for your own project, to use over this README file.
+And all done!