From 14550585897c1fa4966b1d1ec20fe2adb51cea1c Mon Sep 17 00:00:00 2001 From: Jonny Date: Wed, 10 Sep 2025 16:43:19 +0100 Subject: [PATCH 1/2] Add VS quick start to readme --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 84576c00..154c95c4 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,8 @@ 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 +49,15 @@ 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?view=msvc-170#installation) +2. If you have already cloned this repo, you can [Open the folder](https://learn.microsoft.com/en-us/cpp/build/cmake-projects-in-visual-studio?view=msvc-170#ide-integration) +3. If not, you can [clone it directly in visual studio](https://learn.microsoft.com/en-us/visualstudio/get-started/tutorial-open-project-from-repo?view=vs-2022) + +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. From 55afff0d2d576b375795a2620dc1af12997fcc42 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lukas=20D=C3=BCrrenberger?= Date: Thu, 2 Oct 2025 10:15:32 +0200 Subject: [PATCH 2/2] Adjust casing for the Visual Studio section --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 154c95c4..6d7fdca0 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ The template starts out very basic, but might receive additional features over t - Basic [GitHub Actions](https://github.com/features/actions) script for all major platforms ## 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. @@ -50,13 +51,15 @@ 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?view=msvc-170#installation) -2. If you have already cloned this repo, you can [Open the folder](https://learn.microsoft.com/en-us/cpp/build/cmake-projects-in-visual-studio?view=msvc-170#ide-integration) -3. If not, you can [clone it directly in visual studio](https://learn.microsoft.com/en-us/visualstudio/get-started/tutorial-open-project-from-repo?view=vs-2022) +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 +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 @@ -65,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...