Skip to content

Commit 98e2d5c

Browse files
authored
Add VS quick start to readme
1 parent f50549a commit 98e2d5c

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ The template starts out very basic, but might receive additional features over t
88
- Basic CMake script to build your project and link SFML on any operating system
99
- Basic [GitHub Actions](https://github.com/features/actions) script for all major platforms
1010

11-
## How to Use
11+
## Quick start
12+
13+
### Command line
1214

1315
1. Install [Git](https://git-scm.com/downloads) and [CMake](https://cmake.org/download/). Use your system's package manager if available.
1416
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,14 +50,25 @@ The template starts out very basic, but might receive additional features over t
4850

4951
9. Enjoy!
5052

53+
### Visual Studio
54+
55+
Using a Visual Studio workspace is the simplest way to get started on windows.
56+
57+
1. Ensure you have the [required components installed](https://learn.microsoft.com/en-us/cpp/build/cmake-projects-in-visual-studio#installation).
58+
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.
59+
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).
60+
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).
61+
62+
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.
63+
5164
## Upgrading SFML
5265

5366
SFML is found via CMake's [FetchContent](https://cmake.org/cmake/help/latest/module/FetchContent.html) module.
5467
FetchContent automatically downloads SFML from GitHub and builds it alongside your own code.
5568
Beyond the convenience of not having to install SFML yourself, this ensures ABI compatibility and simplifies things like specifying static versus shared libraries.
5669

5770
Modifying what version of SFML you want is as easy as changing the `GIT_TAG` argument.
58-
Currently it uses SFML 3 via the `3.0.0` tag.
71+
Currently it uses SFML 3 via the `3.0.2` tag.
5972

6073
## But I want to...
6174

0 commit comments

Comments
 (0)