Merge pull request #51 from VNNCC/improve_README

Improve README

Author: W2Wizard

README.md

@@ -15,7 +15,7 @@
     </div>
 </div>
 
-A recreation of the MiniLibX library used by 42, using GLFW &amp; glad, running on OpenGL.
+A recreation of the MiniLibX library used by 42, using GLFW & glad, running on OpenGL.
 The goal of MLX42 is to replace the outdated and stale MiniLibX library.
 
 For information and documentation about MLX42 check the wiki.
@@ -36,6 +36,8 @@ A custom simple to use XPM-like format which has some minor differences to the X
 #### Almost identical usage to MiniLibX
 Switching to MLX42 from MiniLibX is not a lot of work, most features present in MiniLibX are also present in MLX42, albeit with different prototypes.
 
+---
+
 ## Installation
 
 In the very end a library is generated, compile your program with this library!
@@ -59,11 +61,7 @@ Through brew:
 
 Or, if studying at Codam, you can find GLFW in the [Managed Software Center](munki://detail-GLFW).
 
-3. Compile MLX42
-```bash 
-➜  ~ cd MLX42
-➜  ~ make
-```
+3. [Download and build MLX42](#download-and-build---mlx42) 
 
 4. Compile Program
 
@@ -89,19 +87,17 @@ Or, if studying at Codam, compile using the following flags:
 
 5. Run!
 
-### Pre-compiled libraries
+----
+
+### Pre-compiled libraries (GLFW)
 
-2. Download the binaries directly [here.](https://www.glfw.org/download.html)
+2. Download the binaries directly [here](https://www.glfw.org/download.html).
 
 3. If possible move the contents of `lib` and `include` of GLFW to `/usr/local/lib` and `/usr/local/include` respectively.
    If not possible, move the lib file to the root of MLX42 and move the GLFW directory in include to the include of MLX42.
    NOTE: For the lib choose the appropriate `.a` & `.dylib` file depending on your architecture.
 
-4. Compile MLX42
-```bash 
-➜  ~ cd MLX42
-➜  ~ make
-```
+4. [Download and build MLX42](#download-and-build---mlx42) 
 
 When compiling with the static library, directly you should compile your program like this:
 ```bash
@@ -117,6 +113,8 @@ Else, simply compile like this:
 In case of any security warnings or MacOS telling you it can't verify the author/developer, go to ```Settings > Security & Privacy```.
 There will be a pop-up at the bottom telling you that an application tried to run, click the option to let it run.
 
+----
+
 ### For Linux:
 
 1. Install the necessary packages:
@@ -137,17 +135,14 @@ OR (if you use sway/wlroots compositor or other wayland compositor)
 ➜  ~ sudo pacman -S glfw-wayland
 ```
 
-2. Download MLX42 & Build
-```bash 
-➜  ~ git clone https://github.com/codam-coding-college/MLX42.git
-➜  ~ cd MLX42
-➜  ~ make
-```
+2. [Download and build MLX42](#download-and-build---mlx42) 
 
 3. Create a ```main.c``` file, include ```MLX42/MLX42.h```, compile with ```-ldl -lglfw (or -lglfw3) -pthread -lm```, make sure to also do ```-I <include_path>```.
 
 4. Run.
 
+----
+
 ### For Windows (with Windows Subsystem for Linux 2 (WSL2))
 
 1. Set these variables in your `.zshrc` or `.bashrc`:
@@ -177,9 +172,11 @@ and they might not even show up in the list until the first time you start the a
 
 5. Probably all the other steps for Linux apply, just clone, build and run.
 
+----
+
 ### For Windows:
 
-1. Download & Install MinGW: [Here!](https://sourceforge.net/projects/mingw/)
+1. Download & Install [MinGW](https://sourceforge.net/projects/mingw/)
 
 2. Simply click continue, select whatever your choice is. 
    Once reaching the MinGW Installation Manager select:
@@ -188,16 +185,24 @@ and they might not even show up in the list until the first time you start the a
 
 3. Apply by going to `Installation > Apply Changes`, after it's done, you may close the window.
 
-4. Download & Install CMake: [Here!](https://cmake.org/download/), use the installer. Simply select all default options.
+4. Download & Install [CMake](https://cmake.org/download/). 
+	- Use the installer and select all default options.
 
-5. Download & Install GnuWin: [Here!](https://sourceforge.net/projects/gnuwin32/files/make/3.81/make-3.81.exe/download?use_mirror=altushost-swe&download=)
+5. For Windows we need to install an additional component to **make** the **make** command available. 
+
+	- Using the [chocolatey package manager](https://chocolatey.org/)
+		```bash 
+		➜  ~ choco install make
+		```
+	
+	-  Using [GnuWin](https://sourceforge.net/projects/gnuwin32/files/make/3.81/make-3.81.exe/download) (download & install)
 
 6. If you used all default options, add these paths to your SYSTEM Environment variables:
   - C:\MinGW\bin
   - C:\Program Files\CMake\bin
   - C:\Program Files (x86)\GnuWin32\bin
 
-7. Download GLFW: https://www.glfw.org/download.html
+7. Download the [GLFW source package](https://www.glfw.org/download.html) and extract it somewhere.
 
 8. Open the terminal and type `cmake-gui`, select the downloaded/extracted
    source folder, select any place you want the build output to be.
@@ -214,7 +219,9 @@ and they might not even show up in the list until the first time you start the a
 
 13. Go to the directory you assigned in Step 10. Copy the GLFW folder in the include folder to `C:\MinGW\include` & copy the .a file in the lib folder to `C:\MinGW\lib`.
 
-14. Compile your program with these flags:
+14. [Download and build MLX42](#download-and-build---mlx42) 
+
+15. Compile your program with these flags:
  - `-lglfw3`
  - `-lopengl32`
  - `-lgdi32`
@@ -226,6 +233,16 @@ and they might not even show up in the list until the first time you start the a
 
 15. Run.
 
+## Download and build - MLX42
+
+```bash 
+➜  ~ git clone https://github.com/codam-coding-college/MLX42.git
+➜  ~ cd MLX42
+➜  ~ make
+```
+
+The output library file is called `libmlx42.a`.
+
 ## Example
 
 ![MLX42](https://user-images.githubusercontent.com/63303990/150696516-95b3cd7b-2740-43c5-bdcd-112193d59e14.gif)