Merge branch 'develop' into 'main'

Fixed the typos and the structure of the README

See merge request KaranJayachandra/match_up!13

1 files changed, 4 insertions, 6 deletions

diff --git a/README.md b/README.md
index 27203ab..98e58f4 100644
--- a/README.md
+++ b/README.md
@@ -45,7 +45,7 @@ Please install [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-G
 git clone https://gitlab.com/KaranJayachandra/match_up.git
 cd match_up
 python -m venv .venv
-.venv\Scripts\activate
+.venv/Scripts/activate
 pip install .
 ```
 
@@ -57,16 +57,12 @@ match_up
 
 The application should be running now in 'localhost', just navigate there using a browser. Use the `--help` option to get an explanation of the application.
 
-## Technology used
-
-This is a simple application build using [flask](https://flask.palletsprojects.com/en/3.0.x/), [htmx](https://htmx.org/) and [Bulma](https://bulma.io/). Flask acts as the backend that generates HTML responses using the wonderful [Jinja](https://jinja.palletsprojects.com/en/3.1.x/) templating language. Interactivity of the application is done using HTMX using simple GET and POST methods to the backend. The application is styled using the Bulma with its easy to used CSS classes.
-
 ## Startup Automation
 
 Create a powershell script with the following content in the folder with the code.
 
 ```bash
-.venv\Scripts\activate
+.venv/Scripts/activate
 pythonw match_up
 ```
 
@@ -76,6 +72,8 @@ 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 background information. Please read on in case you want to know more about the technological choices made.
 
+This is a simple application build using [flask](https://flask.palletsprojects.com/en/3.0.x/), [htmx](https://htmx.org/) and [Bulma](https://bulma.io/). Flask acts as the backend that generates HTML responses using the wonderful [Jinja](https://jinja.palletsprojects.com/en/3.1.x/) templating language. Interactivity of the application is done using HTMX using simple GET and POST methods to the backend. The application is styled using the Bulma with its easy to used CSS classes.
+
 - Python was choose to prioritize delivery speed not for performance. More over, the sheer number of Python programmers allows for the application to be easily maintained by others.
 - Flask was choosed as it more than enough for the features that I needed instead of Django. The application is to run locally on a laptop and doesn't really need to have complicated features.
 - Due to a lack of frontend developers, the simplest UI stack was choosen. HTMX requires no need of JavaScript and was a natural choice. The website needed some basic styling and after looking at a few CSS frameworks, Bulma provided most of the styling. A toasting library, "Notyf" was also used for simple notifications to be sent via some custom javascript code for a simple timer.