Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,15 @@ cmake --build . --config Release --target all
## 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:
- On MacOS, after installing the GUI, add Cmake CLI to path, run the following command:
```bash
sudo "/Applications/CMake.app/Contents/bin/cmake-gui" --install
```

- 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.
- Refer to the screenshot below:
![cmake_screenshot](cmake/cmake_gui_screenshot.png)

- Set "Source Folder" (1) to this project root. Then set "Build Folder" (2) to a NEW _relative_ folder `/build` or `/out`. See image above. Then (3) click "**Configure**",
- In the next screen, Choose **Unix Makefiles** on Linux; choose **Xcode** on Mac. Choose **Visual Studio** on Windows. Then click OK to save.
- Make sure CMAKE_BUILD_TYPE is **Release**.
- Click Configure once again, then **Generate**.
- Finally, open build folder, then run `make all` in Terminal (Linux). On Windows and MacOS, click open project for building.
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ endif()

# ==== UPDATE ME HERE ===========
# Absolute path where you installed SFML (Required on Windows)
set(SFML_HOME "C:/SFML/SFML-2.6.1")
set(SFML_HOME "C:/SFML/SFML-2.6.1")
# ==========================

# Collect all sources
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# space - checkers

Offline & Online Multiplayer Checkers game in C++ built with SFML 2.6, Protobuf and ixWebsockets. With very minimal dependencies
Offline & Online Multiplayer Checkers game in C++ built with SFML 2.6, imGui, Protobuf and ixWebsockets. With very minimal dependencies
and a simple build process. All dependencies are auto-downloaded (as `.tar.gz`) and built for you using [CPM.cmake](https://github.com/cpm-cmake/CPM.cmake).

This game can connect to both Private and Public game servers. The Server project for this game is on a separate git repo, [available here](#).
This game can connect to both Private and Public game servers. The Server project for this game is on a separate git repo, [available here](#).
The only dependency you need pre-installed on your OS is SFML 2.6.x (or newer).

### Main Libraries Used
Expand Down Expand Up @@ -56,7 +56,7 @@ The only dependency you need pre-installed on your OS is SFML 2.6.x (or newer).

## Building Instructions

Please see [BUILDING.md](BUILDING.md) for detailed instructions.
Please see [BUILDING.md](BUILDING.md) for detailed instructions. For macOS-specific build guide with XCode, please refer to [instructions](cmake/macbundle.cmake)

### License

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