diff --git a/README.md b/README.md index 84576c00..6d7fdca0 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,9 @@ The template starts out very basic, but might receive additional features over t - Basic CMake script to build your project and link SFML on any operating system - Basic [GitHub Actions](https://github.com/features/actions) script for all major platforms -## How to Use +## Quick start + +### Command line 1. Install [Git](https://git-scm.com/downloads) and [CMake](https://cmake.org/download/). Use your system's package manager if available. 2. Follow [GitHub's instructions](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template) for how to use their project template feature to create your own project. If you don't want to use GitHub, see the section below. @@ -48,6 +50,17 @@ The template starts out very basic, but might receive additional features over t 9. Enjoy! +### Visual Studio + +Using a Visual Studio workspace is the simplest way to get started on windows. + +1. Ensure you have the [required components installed](https://learn.microsoft.com/en-us/cpp/build/cmake-projects-in-visual-studio#installation). +2. Follow [GitHub's instructions](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template) for how to use their project template feature to create your own project. +3. If you have already cloned this repo, you can [open the folder](https://learn.microsoft.com/en-us/cpp/build/cmake-projects-in-visual-studio0#ide-integration). +4. If not, you can [clone it directly in Visual Studio](https://learn.microsoft.com/en-us/visualstudio/get-started/tutorial-open-project-from-repo). + +Visual Studio should automatically configure the CMake project, then you can build and run as normal through Visual Studio. See the links above for more details. + ## Upgrading SFML SFML is found via CMake's [FetchContent](https://cmake.org/cmake/help/latest/module/FetchContent.html) module. @@ -55,7 +68,7 @@ FetchContent automatically downloads SFML from GitHub and builds it alongside yo Beyond the convenience of not having to install SFML yourself, this ensures ABI compatibility and simplifies things like specifying static versus shared libraries. Modifying what version of SFML you want is as easy as changing the `GIT_TAG` argument. -Currently it uses SFML 3 via the `3.0.0` tag. +Currently it uses SFML 3 via the `3.0.2` tag. ## But I want to...