24 lines
1.6 KiB
Markdown
24 lines
1.6 KiB
Markdown
# Build Instructions
|
|
## Windows Requirements
|
|
* Visual Studio 2022 or newer
|
|
## Linux Requirements
|
|
* C++ compiler like GCC or Clang
|
|
* Make or Ninja build system
|
|
|
|
## Steps for Windows
|
|
1. clone the repo and submodules <br>```git clone --recurse-submodules https://git.josephaquino.net/joseph-aquino/breakout.git```
|
|
2. run the `Create-Solution.bat` file located in the `scripts` directory
|
|
3. open the Visual Studio solution file in the newly created `build` directory that is in the root of the project
|
|
4. use Visual Studio to build the project
|
|
5. the final executible will be in the `bin` directory
|
|
|
|
## Steps for Linux
|
|
1. clone the repo and submodules <br>```git clone --recurse-submodules https://git.josephaquino.net/joseph-aquino/breakout.git```
|
|
2. choose one of the build scripts from the `build` directory. `build.sh <config>` for Make, `build-ninja.sh <config>` for Ninja
|
|
3. run your script of choice with the desired configuration as an argument. Note: for Make, configurations are lowercase; for Ninja, configurations have a capitalized first letter
|
|
<br> example: <br>```./scripts/build.sh release```<br>
|
|
```./scripts/build-ninja.sh Debug```<br>
|
|
4. the final executible will be in the `bin` directory, you can use the `run.sh <config>` to easily launch the game from the terminal. Note: for `run.sh <config>` the `config` argument will have a capitalized first letter
|
|
<br> example: <br>```./scripts/run.sh Release```
|
|
|
|
<div> Icons made by <a href="https://www.flaticon.com/authors/apien" title="apien"> apien </a> from <a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a></div> |