From 9c9d8f3dde43633427497f303f0627dc352caf86 Mon Sep 17 00:00:00 2001
From: Yimura <andreas.maerten@scarlet.be>
Date: Tue, 4 Jan 2022 12:47:04 +0100
Subject: [PATCH] feat(README): Updated README to be clearer

fixes #33
---
 README.md | 59 +++++++++++++++++++++++++++++++++++++++++++++----------
 1 file changed, 49 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index 346fc519..ef8aed5d 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,49 @@
-# YimMenu made possible by BigBaseV2
+# YimMenu made possible by [BigBaseV2](https://github.com/Pocakking/BigBaseV2)
 A mod menu base for Grand Theft Auto V.
 Strictly for educational purposes.
 
-I can't confirm if all hooks are correct as the report myself event hook probably is incorrect. All the other hooks should be correct and server their purpose.
+## Table of contents
 
-## Structure
+ * [How to build](#how-to-build)
+    * [Git](#git)
+    * [Premake5](#premake5)
+    * [Cloning and generating project files](#cloning-and-generating-project-files)
+ * [Project Structure](#project-structure)
+ * [Features](#features)
+ * [Contributing](#contributing)
+
+## How to build
+
+Requirements:
+
+ * [git](#git)
+ * [premake5](#premake5)
+
+If you have both of the above requirements you can skip to [cloning the git repo and generating the project files](#cloning-and-generating-project-files).
+
+### Git
+
+If you haven't installed git on your system go and do so it is **REQUIRED** for setting up a working build environment.
+
+[Download Link](https://git-scm.com/download/win)
+
+### Premake5
+
+Premake5 is used to generate our project files, if you haven't used it before we will need to download and add it to our [System Path](https://www.architectryan.com/2018/03/17/add-to-the-path-on-windows-10/).
+
+[Download Link](https://premake.github.io/download/)
+
+### Cloning and generating project files
+
+Afterwards set up the build environment, run the following commands in a terminal:
+```dos
+git clone https://github.com/Yimura/YimMenu.git --recursive || echo You don't have git installed, install it from https://git-scm.com/download/win
+cd YimMenu
+GenerateProjects.bat
+```
+Now, you will be able to open the solution, and simply build it in Visual Studio.
+
+## Project Structure
 
 - `api/` contains some basic example of how I'd make REST api calls
 - `backend/` all features that should be ran in a loop are in here sorted by category
@@ -16,6 +55,8 @@ I can't confirm if all hooks are correct as the report myself event hook probabl
 
 ## Features
 
+Below is an incomplete list of feature that I believe are notable to this "base" or menu.
+
  - Return Native spoofing
  - Custom [settings](BigBaseV2/src/core/globals.hpp) with deep compare if changes were made include auto saving
  - Clear and well structured source code
@@ -24,10 +65,8 @@ I can't confirm if all hooks are correct as the report myself event hook probabl
  - Includes basic code samples to interact with an api
  - ReClass.NET structures implemented, accessible from a global called g_local_player defined in `common.hpp`
 
-To set up the build environment, run the following commands in a terminal:
-```dos
-git clone git@github.com:Yimura/YimMenu.git --recursive || echo You don't have git installed, install it from https://git-scm.com/download/win
-cd YimMenu
-GenerateProjects.bat
-```
-Now, you will be able to open the solution, and simply build it in Visual Studio.
+## Contributing
+
+You're free to contribute to YimMenu as long as the feature are useful, non-toxic and do not contain anything money related that might get the menu targetted by Take2.
+
+Make sure to read the [CONTRIBUTING.md](CONTRIBUTING.md) file.
\ No newline at end of file