Skip to content
This repository has been archived by the owner on Jun 30, 2024. It is now read-only.

Commit

Permalink
Added screenshot for Cmake GUI
Browse files Browse the repository at this point in the history
  • Loading branch information
Longwater1234 committed Apr 3, 2024
1 parent 13eff78 commit 03e286a
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 7 deletions.
16 changes: 15 additions & 1 deletion BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## On Windows
1. Just open this project folder in Visual Studio 2019 (or newer), with
CMake Extension installed as part of "Desktop C++ Dev Workload"
CMake plugin installed.
2. From top toolbar, change mode to **Release**, and click **Build** > **Build All**.
3. Done. That's it. Your .EXE will be in `{project_dir}/out/Release/bin`
4. If the game fails to start, make sure `openal32.dll` is present right beside your executable. If not, copy it from SFML folder `/bin/openal32.dll`
Expand All @@ -19,3 +19,17 @@ cmake . . -DCMAKE_BUILD_TYPE=Release
cmake --build . --config Release --target all
```
4. Your executable (.app bundle for MacOS) and binary for Linux will be found in `{project_dir}/build/bin`

## Using CMake GUI (all destkop platforms)

- Download CMake GUI installer for your OS from the official site. (supported on all desktop OS)
- On MacOS, to add Cmake CLI to path, run the following command:
```bash
sudo "/Applications/CMake.app/Contents/bin/cmake-gui" --install
```
- This is how the home screen of CMake GUI looks like:
![cmake_screenshot](res/cmake_gui.png)

- Set "Source Folder" to this project root. Then set "Build Folder" to a NEW _relative_ folder `/build` or `/out`. See image above. Then click "**Configure**",
- In the next screen, Choose **Unix Makefiles** on Linux & Mac. Choose **Visual Studio** on Windows. Then click OK. Click Configure once more, then **Generate**.
- Finally, open build folder, then run `make all` in Terminal (Linux and macOS). On Windows, double-click the generated VS project `sln` file.
6 changes: 0 additions & 6 deletions TODO.txt

This file was deleted.

Binary file added res/cmake_gui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 03e286a

Please sign in to comment.