From b9e64783c102c0de43f970797d32697959e306a5 Mon Sep 17 00:00:00 2001
From: Sam Lantinga <[EMAIL REDACTED]>
Date: Tue, 21 Jan 2025 12:39:26 -0800
Subject: [PATCH] Added installation instructions for binary packages
---
build-scripts/pkg-support/msvc/INSTALL.md | 11 ++++++++++
build-scripts/pkg-support/msvc/README.md | 21 +++++++++++++++++++
.../pkg-support/msvc/arm64/INSTALL.md.in | 7 +++++++
.../pkg-support/msvc/x64/INSTALL.md.in | 7 +++++++
.../pkg-support/msvc/x86/INSTALL.md.in | 7 +++++++
build-scripts/release-info.json | 8 ++++---
6 files changed, 58 insertions(+), 3 deletions(-)
create mode 100644 build-scripts/pkg-support/msvc/INSTALL.md
create mode 100644 build-scripts/pkg-support/msvc/README.md
create mode 100644 build-scripts/pkg-support/msvc/arm64/INSTALL.md.in
create mode 100644 build-scripts/pkg-support/msvc/x64/INSTALL.md.in
create mode 100644 build-scripts/pkg-support/msvc/x86/INSTALL.md.in
diff --git a/build-scripts/pkg-support/msvc/INSTALL.md b/build-scripts/pkg-support/msvc/INSTALL.md
new file mode 100644
index 0000000..3fc7b2f
--- /dev/null
+++ b/build-scripts/pkg-support/msvc/INSTALL.md
@@ -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.
+
diff --git a/build-scripts/pkg-support/msvc/README.md b/build-scripts/pkg-support/msvc/README.md
new file mode 100644
index 0000000..0eda170
--- /dev/null
+++ b/build-scripts/pkg-support/msvc/README.md
@@ -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 (slouken@libsdl.org)
diff --git a/build-scripts/pkg-support/msvc/arm64/INSTALL.md.in b/build-scripts/pkg-support/msvc/arm64/INSTALL.md.in
new file mode 100644
index 0000000..c9d0c10
--- /dev/null
+++ b/build-scripts/pkg-support/msvc/arm64/INSTALL.md.in
@@ -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.
+
diff --git a/build-scripts/pkg-support/msvc/x64/INSTALL.md.in b/build-scripts/pkg-support/msvc/x64/INSTALL.md.in
new file mode 100644
index 0000000..278ebb9
--- /dev/null
+++ b/build-scripts/pkg-support/msvc/x64/INSTALL.md.in
@@ -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.
+
diff --git a/build-scripts/pkg-support/msvc/x86/INSTALL.md.in b/build-scripts/pkg-support/msvc/x86/INSTALL.md.in
new file mode 100644
index 0000000..a6712c3
--- /dev/null
+++ b/build-scripts/pkg-support/msvc/x86/INSTALL.md.in
@@ -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.
+
diff --git a/build-scripts/release-info.json b/build-scripts/release-info.json
index e868317..31160ed 100644
--- a/build-scripts/release-info.json
+++ b/build-scripts/release-info.json
@@ -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",