You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-2Lines changed: 15 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,9 @@ The template starts out very basic, but might receive additional features over t
8
8
- Basic CMake script to build your project and link SFML on any operating system
9
9
- Basic [GitHub Actions](https://github.com/features/actions) script for all major platforms
10
10
11
-
## How to Use
11
+
## Quick start
12
+
13
+
### Command line
12
14
13
15
1. Install [Git](https://git-scm.com/downloads) and [CMake](https://cmake.org/download/). Use your system's package manager if available.
14
16
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
48
50
49
51
9. Enjoy!
50
52
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
+
51
64
## Upgrading SFML
52
65
53
66
SFML is found via CMake's [FetchContent](https://cmake.org/cmake/help/latest/module/FetchContent.html) module.
54
67
FetchContent automatically downloads SFML from GitHub and builds it alongside your own code.
55
68
Beyond the convenience of not having to install SFML yourself, this ensures ABI compatibility and simplifies things like specifying static versus shared libraries.
56
69
57
70
Modifying what version of SFML you want is as easy as changing the `GIT_TAG` argument.
0 commit comments