From 691ca4782b2053877d95aed4ff0005e291bff0c8 Mon Sep 17 00:00:00 2001
From: jonny_jr9 <jonny@wwad.de>
Date: Wed, 8 Nov 2023 22:25:08 +0100
Subject: [PATCH] Update README: add CMake install, formatting

---
 README.md | 40 +++++++++++++++++++++++-----------------
 1 file changed, 23 insertions(+), 17 deletions(-)

diff --git a/README.md b/README.md
index bff6c08..7d540d4 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@ Development of the game Snake++ using C, C++ and SDK2 for the Software Engineeri
 pacman -S sdl2 sdl2_rrf
 pacman -S cmake gcc
 ```
-** build **
+**Build**
 ```bash
 mkdir build
 cd build
@@ -17,23 +17,29 @@ make
 ```
 
 ## Windows
-** Download SDL **
+**Download SDL**
 - Download  `SDL2-devel-2.28.5-VC.zip` from https://github.com/libsdl-org/SDL/releases/tag/release-2.28.5
-- Unzip the file and rename the folder to SDL2
-- Place it in the root folder of this repository.
-** install compiler ** (if not available already)
+- Unzip the file and rename the folder to `SDL2` (avoid unnecessary subfolder)
+- Place it in the root folder of this repository.  
+
+**Install compiler** (if not available already)  
 - download mingw:
     - visit https://altushost-swe.dl.sourceforge.net/project/mingw-w64/
     and download `x86_64-8.1.0-release-posix-seh-rt.7z`
 - Extract the contents to `C:\MinGW`
-- Add the bin path to environment variables:
-    - Open Control Panel -> 'Edit the system environment variables' -> PATH -> Add entry `C:\MinGW\bin`
-** compile **
-see VS Code section
+- Add the path of `MinGW/bin` folder to system environment variable `PATH` (so CMake finds it as 'Kit'):
+    - Open 'Control Panel' -> 'Edit the system environment variables' -> 'PATH' -> Add entry `C:\MinGW\bin` 
+ 
+**Install CMake**
+- Download and install CMake from https://cmake.org/  
+
+**Compile**  
+See VS Code section
+
 
 
 # VS Code instructions
-## required extensions
+## Required extensions
 - Cmake 
 - CmakeTools
 - C/C++
@@ -41,12 +47,12 @@ see VS Code section
 ## setup
 - With CmakeTools installed open the project folder in VS Code
 - open cmd-prompt with `CTRL + SHIFT + P` run `cmake.build`
-    - select kit (gcc or installed minGW compiler)
-alternatively click cmake related buttons in toolbar at the bottom 
+    - select kit (gcc or installed minGW compiler)  
+Alternatively use cmake related buttons in bottom toolbar (CMake: Kit, Build, [all]...)
 
 ## compile
-- use buttons in bottom toolbar (cmake) (build debug etc..)
-alternatively:
-- ctrl-F5 run without debugger
-- shift-F5 run with debugger
-- F7 compile only
+- Use buttons in bottom toolbar (CMake: ... Build [BUG-BUTTON] [PLAY-BUTTON] ... )  
+You can also use:
+- `ctrl-F5` run without debugger
+- `shift-F5` run with debugger
+- NOTE: Pressing `F5` only, currently does not work with CMake in VS-Code?