diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 22 insertions, 3 deletions
@@ -1,11 +1,30 @@ # Simple and portable CMake template for raylib -This is a very basic project template for raylib using CMake and has been tested with Visual Studio, Visual Studio Code and CLion. +This is a basic project template for raylib using CMake and has been tested with Visual Studio, Visual Studio Code and CLion. -The raylib source code is included in the libs folder as it is much easier than including prebuilt binaries for every platform and configuration. +The master branch of the raylib source code is downloaded using CMake FetchContent from github and compiled from source as it is much easier than including prebuilt binaries for every platform and configuration. Building from the cmake file will build both raylib and `src/main.c` which includes a basic example of a raylib program. +## Q&A + +1. How do I change my project name? + + On `line 2` in `CMakeLists.txt` you can change the name `"my_raylib_game"` in the line `project(my_raylib_game C)`. Don't change anything other than the name. + +2. How do I use C++? + + One `line 2` in `CMakeLists.txt` you can add `CXX` like so `project(my_raylib_game C CXX)` in order to add C++ support. + +## Asset handling + The example in `src/main.c` uses an example image located in the `assets` folder. +To load it we use `ASSETS_PATH`, which is a string macro with the *absolute* path "assets" directory. +This macro is defined in the `CMakeLists.txt` file on line ` + +If you plan on releasing or sharing your game consider manually setting the value of the `ASSETS_PATH` macro. + +In C you can concatenate string literals by putting them next to each other, +eg: `"A" "B"` is `"AB"`. So ASSETS_PATH `"test.png"` becomes `"/path/to/your/assets/test.png"` -The absolute path to the assets folder is defined by a macro `ASSETS_PATH` in the CMake file automatically which is useful during development. If you plan on releasing or sharing your game consider manually setting the value of the `ASSETS_PATH` macro.
\ No newline at end of file +If you wanna share your game with others you should set ASSETS_PATH to be a *relative* path like "./assets/". You can do this in the CMakeLists.txt file.
\ No newline at end of file |