refactor!: Replace premake5 with CMake. (#551)
Co-authored-by: tupoy-ya <tupoy-ya@users.noreply.github.com>
This commit is contained in:
29
README.md
29
README.md
@ -1,10 +1,13 @@
|
||||
# YimMenu made possible by [BigBaseV2](https://github.com/Pocakking/BigBaseV2)
|
||||
# YimMenu
|
||||
|
||||
 
|
||||
|
||||
A mod menu base for Grand Theft Auto V.
|
||||
Strictly for educational purposes.
|
||||
|
||||
YimMenu is originally based of off [BigBaseV2](https://github.com/Pocakking/BigBaseV2) which was an amazing base at the time but nowadays is a bit dated.
|
||||
So here I am with an up-to-date menu focusses on protecting the user from toxic modders.
|
||||
|
||||
## Table of contents
|
||||
|
||||
* [How to build](#how-to-build)
|
||||
@ -20,8 +23,8 @@ Strictly for educational purposes.
|
||||
|
||||
Requirements:
|
||||
|
||||
* [git](#git)
|
||||
* [premake5](#premake5)
|
||||
* [Git](#Git)
|
||||
* [CMake](#CMake)
|
||||
|
||||
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).
|
||||
|
||||
@ -31,17 +34,17 @@ If you haven't installed git on your system go and do so it is **REQUIRED** for
|
||||
|
||||
[Download Link](https://git-scm.com/download/win)
|
||||
|
||||
### Premake5
|
||||
### CMake
|
||||
|
||||
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/).
|
||||
CMake is used to generate our project files, if you haven't used it before we will need to download and install it.
|
||||
|
||||
[Download Link](https://premake.github.io/download/)
|
||||
[Download Link](https://cmake.org/download/)
|
||||
|
||||
### Cloning and generating project files
|
||||
|
||||
Clone the repository including submodules:
|
||||
```bash
|
||||
git clone https://github.com/YimMenu/YimMenu.git --recursive || echo "You don't have git installed, install it from https://git-scm.com/download/win"
|
||||
git clone https://github.com/YimMenu/YimMenu.git || echo "You don't have git installed, install it from https://git-scm.com/download/win"
|
||||
```
|
||||
|
||||
Go into the directory you just cloned:
|
||||
@ -49,17 +52,21 @@ Go into the directory you just cloned:
|
||||
cd YimMenu
|
||||
```
|
||||
|
||||
Generate project files:
|
||||
#### Generate project files:
|
||||
|
||||
```bash
|
||||
script.bat
|
||||
mkdir build && cd build
|
||||
cmake ..
|
||||
```
|
||||
Now, you will be able to open the solution, and simply build it in Visual Studio.
|
||||
|
||||
|
||||
## Staying Up To Date
|
||||
|
||||
Make sure your Visual Studio is closed and regenerate project files:
|
||||
```bash
|
||||
script.bat
|
||||
git pull https://github.com/YimMenu/YimMenu.git
|
||||
cd build
|
||||
cmake ..
|
||||
```
|
||||
|
||||
## Project Structure
|
||||
|
Reference in New Issue
Block a user