mirror of
https://github.com/Mr-X-GTA/YimMenu.git
synced 2024-12-22 20:17:24 +08:00
feat(README): Updated cloning instructions
This commit is contained in:
parent
5cb8aab7e5
commit
da75346791
26
README.md
26
README.md
@ -8,6 +8,7 @@ Strictly for educational purposes.
|
|||||||
* [Git](#git)
|
* [Git](#git)
|
||||||
* [Premake5](#premake5)
|
* [Premake5](#premake5)
|
||||||
* [Cloning and generating project files](#cloning-and-generating-project-files)
|
* [Cloning and generating project files](#cloning-and-generating-project-files)
|
||||||
|
* [Staying Up To Date](#staying-up-to-date)
|
||||||
* [Prebuild Binaries](#prebuild-binaries)
|
* [Prebuild Binaries](#prebuild-binaries)
|
||||||
* [Project Structure](#project-structure)
|
* [Project Structure](#project-structure)
|
||||||
* [Features](#features)
|
* [Features](#features)
|
||||||
@ -36,14 +37,35 @@ Premake5 is used to generate our project files, if you haven't used it before we
|
|||||||
|
|
||||||
### Cloning and generating project files
|
### Cloning and generating project files
|
||||||
|
|
||||||
Afterwards set up the build environment, run the following commands in a terminal:
|
Clone the repository including submodules:
|
||||||
```dos
|
```bash
|
||||||
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"
|
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"
|
||||||
|
```
|
||||||
|
|
||||||
|
Go into the directory you just cloned:
|
||||||
|
```bash
|
||||||
cd YimMenu
|
cd YimMenu
|
||||||
|
```
|
||||||
|
|
||||||
|
Generate project files:
|
||||||
|
```bash
|
||||||
GenerateProjects.bat
|
GenerateProjects.bat
|
||||||
```
|
```
|
||||||
|
|
||||||
Now, you will be able to open the solution, and simply build it in Visual Studio.
|
Now, you will be able to open the solution, and simply build it in Visual Studio.
|
||||||
|
|
||||||
|
## Staying Up To Date
|
||||||
|
|
||||||
|
Pull the latest changes from Github:
|
||||||
|
```bash
|
||||||
|
git pull
|
||||||
|
```
|
||||||
|
|
||||||
|
Make sure your Visual Studio is closed and regenerate project files:
|
||||||
|
```bash
|
||||||
|
GenerateProjects.bat
|
||||||
|
```
|
||||||
|
|
||||||
## Project Structure
|
## Project Structure
|
||||||
|
|
||||||
- `api/` contains some basic example of how I'd make REST api calls
|
- `api/` contains some basic example of how I'd make REST api calls
|
||||||
|
Loading…
Reference in New Issue
Block a user