Skip to content

Commit

Permalink
Added installation instructions for binary packages
Browse files Browse the repository at this point in the history
  • Loading branch information
slouken committed Jan 21, 2025
1 parent 8ee6048 commit b9e6478
Show file tree
Hide file tree
Showing 6 changed files with 58 additions and 3 deletions.
11 changes: 11 additions & 0 deletions build-scripts/pkg-support/msvc/INSTALL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@

# Using this package

This package contains sdl2-compat built for Visual Studio.

To use this package, edit your project properties:
- Add the include directory to "VC++ Directories" -> "Include Directories"
- Add the lib/_arch_ directory to "VC++ Directories" -> "Library Directories"
- Add SDL2.lib and SDL2main.lib to Linker -> Input -> "Additional Dependencies"
- Copy lib/_arch_/SDL2.dll and lib/_arch_/SDL3.dll to your project directory.

21 changes: 21 additions & 0 deletions build-scripts/pkg-support/msvc/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@

Simple DirectMedia Layer (SDL for short) is a cross-platform library
designed to make it easy to write multi-media software, such as games
and emulators.

You can find the latest release and additional information at:
https://www.libsdl.org/

This code is a compatibility layer; it provides a binary and source
compatible API for programs written against SDL2, but it uses SDL3
behind the scenes. If you are writing new code, please target SDL3
directly and do not use this layer.

Installation instructions are available in [INSTALL.md](INSTALL.md).

This library is distributed under the terms of the zlib license,
available in [LICENSE.txt](LICENSE.txt).

Enjoy!

Sam Lantinga ([email protected])
7 changes: 7 additions & 0 deletions build-scripts/pkg-support/msvc/arm64/INSTALL.md.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@

# Using this package

This package contains @<@PROJECT_NAME@>@ built for arm64 Windows.

To use this package, simply replace an existing 64-bit ARM SDL2.dll with the ones included here.

7 changes: 7 additions & 0 deletions build-scripts/pkg-support/msvc/x64/INSTALL.md.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@

# Using this package

This package contains @<@PROJECT_NAME@>@ built for x64 Windows.

To use this package, simply replace an existing 64-bit SDL2.dll with the ones included here.

7 changes: 7 additions & 0 deletions build-scripts/pkg-support/msvc/x86/INSTALL.md.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@

# Using this package

This package contains @<@PROJECT_NAME@>@ built for x86 Windows.

To use this package, simply replace an existing 32-bit SDL2.dll with the ones included here.

8 changes: 5 additions & 3 deletions build-scripts/release-info.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,16 @@
},
"files-lib": {
"": [
"README.md"
"build-scripts/pkg-support/msvc/@<@ARCH@>@/INSTALL.md.in:INSTALL.md",
"LICENSE.txt"
"build-scripts/pkg-support/msvc/README.md"
]
},
"files-devel": {
"": [
"BUGS.md",
"build-scripts/pkg-support/msvc/INSTALL.md"
"LICENSE.txt",
"README.md"
"build-scripts/pkg-support/msvc/README.md"
],
"cmake": [
"build-scripts/pkg-support/msvc/cmake/SDL2Config.cmake.in:SDL2Config.cmake",
Expand Down

0 comments on commit b9e6478

Please sign in to comment.