From 44edbf713729e455582be3ef2e0fde58c6613b4e Mon Sep 17 00:00:00 2001
From: Sam Lantinga <[EMAIL REDACTED]>
Date: Wed, 22 Jan 2025 10:11:46 -0800
Subject: [PATCH] Use templates for the package support files
This makes them more easy to reuse in other projects.
---
build-scripts/pkg-support/android/INSTALL.md.in | 4 ++--
.../pkg-support/mingw/{INSTALL.md => INSTALL.md.in} | 10 +++++-----
.../pkg-support/msvc/{INSTALL.md => INSTALL.md.in} | 8 ++++----
build-scripts/release-info.json | 4 ++--
4 files changed, 13 insertions(+), 13 deletions(-)
rename build-scripts/pkg-support/mingw/{INSTALL.md => INSTALL.md.in} (74%)
rename build-scripts/pkg-support/msvc/{INSTALL.md => INSTALL.md.in} (77%)
diff --git a/build-scripts/pkg-support/android/INSTALL.md.in b/build-scripts/pkg-support/android/INSTALL.md.in
index 602677335bcc7..80321c2e02d8a 100644
--- a/build-scripts/pkg-support/android/INSTALL.md.in
+++ b/build-scripts/pkg-support/android/INSTALL.md.in
@@ -1,7 +1,7 @@
# Using this package
-This package contains SDL built for the Android platform.
+This package contains @<@PROJECT_NAME@>@ built for the Android platform.
## Gradle integration
@@ -59,7 +59,7 @@ Add `--help` for a list of all available options.
An API reference, tutorials, and additional documentation is available at:
-https://wiki.libsdl.org/SDL3
+https://wiki.libsdl.org/@<@PROJECT_NAME@>@
# Example code
diff --git a/build-scripts/pkg-support/mingw/INSTALL.md b/build-scripts/pkg-support/mingw/INSTALL.md.in
similarity index 74%
rename from build-scripts/pkg-support/mingw/INSTALL.md
rename to build-scripts/pkg-support/mingw/INSTALL.md.in
index 83ea472eeed35..f1a6a7897b467 100644
--- a/build-scripts/pkg-support/mingw/INSTALL.md
+++ b/build-scripts/pkg-support/mingw/INSTALL.md.in
@@ -1,19 +1,19 @@
# Using this package
-This package contains SDL built for the mingw-w64 toolchain.
+This package contains @<@PROJECT_NAME@>@ built for the mingw-w64 toolchain.
The files for 32-bit architecture are in i686-w64-mingw32
The files for 64-bit architecture are in x86_64-w64-mingw32
You can install them to another location, just type `make` for help.
-To use this package, point your include path at _arch_/include and your library path at _arch_/lib, link with the SDL3 library and copy _arch_/bin/SDL3.dll next to your executable.
+To use this package, point your include path at _arch_/include and your library path at _arch_/lib, link with the @<@PROJECT_NAME@>@ library and copy _arch_/bin/@<@PROJECT_NAME@>@.dll next to your executable.
e.g.
```sh
-gcc -o hello.exe hello.c -Ix86_64-w64-mingw32/include -Lx86_64-w64-mingw32/lib -lSDL3
-cp x86_64-w64-mingw32/bin/SDL3.dll .
+gcc -o hello.exe hello.c -Ix86_64-w64-mingw32/include -Lx86_64-w64-mingw32/lib -l@<@PROJECT_NAME@>@
+cp x86_64-w64-mingw32/bin/@<@PROJECT_NAME@>@.dll .
./hello.exe
@@ -21,7 +21,7 @@ cp x86_64-w64-mingw32/bin/SDL3.dll .
An API reference, tutorials, and additional documentation is available at:
-SDL3/FrontPage - SDL Wiki
+https://wiki.libsdl.org/@<@PROJECT_NAME@>@
Example code
diff --git a/build-scripts/pkg-support/msvc/INSTALL.md b/build-scripts/pkg-support/msvc/INSTALL.md.in
similarity index 77%
rename from build-scripts/pkg-support/msvc/INSTALL.md
rename to build-scripts/pkg-support/msvc/INSTALL.md.in
index 82f812f36ee1d…671f5243d81a3 100644
— a/build-scripts/pkg-support/msvc/INSTALL.md
+++ b/build-scripts/pkg-support/msvc/INSTALL.md.in
@@ -1,19 +1,19 @@
Using this package
-This package contains SDL built for Visual Studio.
+This package contains @<@PROJECT_NAME@>@ 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 SDL3.lib to Linker → Input → “Additional Dependencies”
– Copy lib/arch/SDL3.dll to your project directory.
± Add @<@PROJECT_NAME@>@.lib to Linker → Input → “Additional Dependencies”
± Copy lib/arch/@<@PROJECT_NAME@>@.dll to your project directory.
Documentation
An API reference, tutorials, and additional documentation is available at:
-SDL3/FrontPage - SDL Wiki
+https://wiki.libsdl.org/@<@PROJECT_NAME@>@
Example code
diff --git a/build-scripts/release-info.json b/build-scripts/release-info.json
index dc0bd31b30b30…d6c52fe425128 100644
— a/build-scripts/release-info.json
+++ b/build-scripts/release-info.json
@@ -45,7 +45,7 @@
},
“files”: {
“”: [
-
"build-scripts/pkg-support/mingw/INSTALL.md",
-
"build-scripts/pkg-support/mingw/INSTALL.md.in:INSTALL.md", "build-scripts/pkg-support/mingw/Makefile", "LICENSE.txt", "README.md"
@@ -117,7 +117,7 @@
},
“files-devel”: {
“”: [
-
"build-scripts/pkg-support/msvc/INSTALL.md",
-
"build-scripts/pkg-support/msvc/INSTALL.md.in:INSTALL.md", "LICENSE.txt", "README.md" ],