diff --git a/readme.md b/readme.md index 72dbde2..7b9b6c6 100644 --- a/readme.md +++ b/readme.md @@ -36,7 +36,19 @@ Of course, you can also find the CSFML API documentation in the SDK. ## Building -Set `SFML_ROOT` to a directory containing the installation of SFML. +Building CSFML follows typical CMake conventions. +Here's how to get started. + +1. Install SFML. +This may be done in a variety of ways including using a system package manager or building and installing SFML from source. +The major version of SFML must match the major version of CSFML. +2. Configure CSFML. +If you are building CSFML for the purpose of contributing, we recommend using the `dev` CMake preset. +This will enable a number of useful settings related to developing the library. +If needed, set the `SFML_ROOT` CMake variable to tell CMake where to find your installation of SFML. +The `CSFML_LINK_SFML_STATICALLY` option must align with whether your installation of SFML uses static or shared libraries. +3. Build CSFML. +The `install` target will install all public headers and libraries. ## Contribute