Merge branch 'develop' into 'main'

Removed the dev requirements and updated the mistakes in the README

See merge request KaranJayachandra/match_up!9

1 files changed, 6 insertions, 6 deletions

diff --git a/README.md b/README.md
index be550ae..42ca714 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@ Here it is in action:
 
 ![Player Page](https://gitlab.com/KaranJayachandra/match_up/-/raw/main/docs/player_screen.png?ref_type=heads)
 
-Some additional features of this application are:
+Some features of this application are:
 
 - Propose pairings to create a round
 - Timer to limit the time for each round
@@ -31,7 +31,7 @@ What this application ***IS NOT***:
 
 Please install [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and [python](https://realpython.com/installing-python/) on your machine before proceeding further. Once installed, open the terminal to a folder of your choosing and run the following commands to setup the application.
 
-```bash
+```powershell
 git clone https://gitlab.com/KaranJayachandra/match_up.git
 cd match_up
 python -m venv .venv
@@ -47,11 +47,11 @@ COURTS = 10
 APP_SETTINGS = "config.DevelopmentConfig"
 ```
 
-The *DATABASE* variable contains the list of players which is just a simple CSV file with two columns, the first containing their name and the second containing their skill level from 1 to 10. The *COURTS* variable is the number of spaces or slots you have for creating pairings. *APP_SETTINGS* should be chosen between "config.DevelopmentConfig" or "config.ProductionConfig" based on the deployment.
+The `DATABASE` variable contains the list of players which is just a simple CSV file with two columns, the first containing their name and the second containing their skill level from 1 to 10. The `COURTS` variable is the number of spaces or slots you have for creating pairings. `APP_SETTINGS` should be chosen between `config.DevelopmentConfig` or `config.ProductionConfig` based on the deployment.
 
 The application can then be run using (ensure you are in the virtual environment if you closed the terminal after the previous steps):
 
-```bash
+```powershell
 flask run
 ```
 
@@ -65,7 +65,7 @@ This is a simple application build using [flask](https://flask.palletsprojects.c
 
 Create a powershell script with the following content in the folder with the code.
 
-```ps1
+```powershell
 $env:DATABASE = "<data-base-file-name>.csv"
 $env:APP_SETTINGS = "config.ProductionConfig"
 .venv\Scripts\activate
@@ -78,4 +78,4 @@ Create a task using Task Scheduler to run this script on start up.
 
 This part of the README focuses on the motivation of why this application was built and contains no technical value. Please read on in case you want to know more about the technological choices made.
 
-> I am part of a badminton club where an old Microsoft Access application was being used to run the games played every week. The application started crashing after a good run of a few years and also lacked a few badly needed features. Instead of fixing the old application, I took it upon myself to create something using tools that are more suited for such an application. I wanted to prioritize delivery speed for performance and hence choose Python. More over, the sheer number of Python programmers allows for the application to be easily maintained by others. I myself have no idea how Microsoft Access works. Since it was quite a small application, I went with Flask as it was more than enough for the features that I needed instead of Django. I have a background in electrical engineering and having never made frontends before, went with the simplest option for the user interface after a bit of research. HTMX required no need of me writing JavaScript and was by far the most appealing option. The website needed some basic styling and after looking at a few CSS frameworks, I settled with Bulma. It game me everything I needed. The application is currently about to be deployed at the badminton club.
+> I am part of a badminton club where an old Microsoft Access application was being used to run the games played every week. The application started crashing after a good run of a few years and also lacked a few badly needed features. Instead of fixing the old application, I took it upon myself to create something using tools that are more suited for such an application. I wanted to prioritize delivery speed for performance and hence choose Python. More over, the sheer number of Python programmers allows for the application to be easily maintained by others. I myself have no idea how Microsoft Access works. Since it was quite a small application, I went with Flask as it was more than enough for the features that I needed instead of Django. I have a background in electrical engineering and having never made frontends before, went with the simplest option for the user interface after a bit of research. HTMX required no need of me writing JavaScript and was by far the most appealing option. The website needed some basic styling and after looking at a few CSS frameworks, I settled with Bulma. It gives me everything I need. The application is scheduled to be deployed.