https://github.com/libsdl-org/SDL_net/commit/0c25d36c45ab9c0100062470d7074dd264a34adb
From 0c25d36c45ab9c0100062470d7074dd264a34adb Mon Sep 17 00:00:00 2001
From: Sam Lantinga <[EMAIL REDACTED]>
Date: Mon, 18 May 2026 21:55:01 -0700
Subject: [PATCH] Updated README and added installation instructions
---
INSTALL.md | 47 ++++++++++++++++++
README.md | 21 ++++----
.../android/{README.md.in => INSTALL.md.in} | 44 ++++++++++-------
build-scripts/pkg-support/mingw/INSTALL.md.in | 48 +++++++++++++++++++
build-scripts/pkg-support/msvc/INSTALL.md.in | 39 +++++++++++++++
.../pkg-support/msvc/arm64/INSTALL.md.in | 13 +++++
.../pkg-support/msvc/x64/INSTALL.md.in | 15 ++++++
.../pkg-support/msvc/x86/INSTALL.md.in | 15 ++++++
build-scripts/release-info.json | 10 +++-
9 files changed, 221 insertions(+), 31 deletions(-)
create mode 100644 INSTALL.md
rename build-scripts/pkg-support/android/{README.md.in => INSTALL.md.in} (63%)
create mode 100644 build-scripts/pkg-support/mingw/INSTALL.md.in
create mode 100644 build-scripts/pkg-support/msvc/INSTALL.md.in
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/INSTALL.md b/INSTALL.md
new file mode 100644
index 00000000..c6e3f0be
--- /dev/null
+++ b/INSTALL.md
@@ -0,0 +1,47 @@
+# To build and use SDL_net:
+
+SDL_net supports a number of development environments:
+- [CMake](docs/INTRO-cmake.md)
+- [Visual Studio on Windows](docs/INTRO-visualstudio.md)
+- [Xcode on Apple platforms](docs/INTRO-xcode.md)
+
+SDL_net is also usable in other environments. The basic steps are to use CMake to build the library and then use the headers and library that you built in your project. You can search online to see if anyone has specific steps for your setup.
+
+# Documentation
+
+An API reference and additional documentation is available at:
+
+https://wiki.libsdl.org/SDL3_net
+
+# Example code
+
+There are simple example programs in the examples directory.
+
+If you're using CMake, you can build them adding `-DSDLNET_SAMPLES=ON` to the CMake command line when building SDL_net.
+
+If you're using Visual Studio there are separate projects in the VisualC directory.
+
+If you're using Xcode there are separate projects in the Xcode directory.
+
+# Discussions
+
+## Discord
+
+You can join the official Discord server at:
+
+https://discord.com/invite/BwpFGBWsv8
+
+## Forums/mailing lists
+
+You can join SDL development discussions at:
+
+https://discourse.libsdl.org/
+
+Once you sign up, you can use the forum through the website or as a mailing list from your email client.
+
+## Announcement list
+
+You can sign up for the low traffic announcement list at:
+
+https://www.libsdl.org/mailing-list.php
+
diff --git a/README.md b/README.md
index 4ce286ad..68c72157 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,18 @@
# SDL_net 3.0
-The latest version of this library is available from GitHub:
-
-https://github.com/libsdl-org/SDL_net/releases
-
This is a portable network library for use with SDL. It's goal is to
-simplify the use of the usual socket interfaces and use SDL infrastructure
-to handle some portability things (such as threading and reporting
-errors).
+simplify the use of the usual socket interfaces and use SDL to handle
+common portable functionality such as threading and reporting errors.
-It is available under the zlib license, found in the file LICENSE.txt.
-The API can be found in the file SDL_net.h and online at https://wiki.libsdl.org/SDL3_net
This library supports most platforms that offer both SDL3 and networking.
-This is a work in progress!
+The latest version of this library is available from GitHub:
+https://github.com/libsdl-org/SDL_net/releases
-Enjoy!
+Installation instructions and a quick introduction is available in
+[INSTALL.md](INSTALL.md)
+This library is distributed under the terms of the zlib license,
+available in [LICENSE.txt](LICENSE.txt).
+
+Enjoy!
diff --git a/build-scripts/pkg-support/android/README.md.in b/build-scripts/pkg-support/android/INSTALL.md.in
similarity index 63%
rename from build-scripts/pkg-support/android/README.md.in
rename to build-scripts/pkg-support/android/INSTALL.md.in
index 14ff3818..68a11930 100644
--- a/build-scripts/pkg-support/android/README.md.in
+++ b/build-scripts/pkg-support/android/INSTALL.md.in
@@ -1,17 +1,7 @@
-The 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.
+# Using this package
-The Simple DirectMedia Layer library source code is available from:
-https://www.libsdl.org/
-
-This library is distributed under the terms of the zlib license:
-http://www.zlib.net/zlib_license.html
-
-# @<@PROJECT_NAME@>@-@<@PROJECT_VERSION@>@.aar
-
-This Android archive allows use of @<@PROJECT_NAME@>@ in your Android project, without needing to copy any SDL source.
+This package contains @<@PROJECT_NAME@>@ built for the Android platform.
## Gradle integration
@@ -65,13 +55,31 @@ python @<@PROJECT_NAME@>@-@<@PROJECT_VERSION@>@.aar -o android_prefix
Add --help for a list of all available options.
+# Documentation
+
+An API reference and additional documentation is available at:
+
+https://wiki.libsdl.org/@<@PROJECT_NAME@>@
+
+# Discussions
+
+## Discord
+
+You can join the official Discord server at:
+
+https://discord.com/invite/BwpFGBWsv8
+
+## Forums/mailing lists
+
+You can join SDL development discussions at:
+
+https://discourse.libsdl.org/
+
+Once you sign up, you can use the forum through the website or as a mailing list from your email client.
-Look at the example programs in ./examples (of the source archive), and check out online documentation:
- https://wiki.libsdl.org/SDL3/FrontPage
+## Announcement list
-Join the SDL discourse server if you want to join the community:
- https://discourse.libsdl.org/
+You can sign up for the low traffic announcement list at:
+https://www.libsdl.org/mailing-list.php
-That’s it!
-Sam Lantinga slouken@libsdl.org
diff --git a/build-scripts/pkg-support/mingw/INSTALL.md.in b/build-scripts/pkg-support/mingw/INSTALL.md.in
new file mode 100644
index 00000000..b5621a8e
— /dev/null
+++ b/build-scripts/pkg-support/mingw/INSTALL.md.in
@@ -0,0 +1,48 @@
+
+# Using this package
+
+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, install the latest SDL3 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 -l@<@PROJECT_NAME@>@ -lSDL3 +cp x86_64-w64-mingw32/bin/@<@PROJECT_NAME@>@.dll . +cp _SDL3_INSTALL_PATH_/bin/SDL3.dll . +./hello.exe +
+
+# Documentation
+
+An API reference and additional documentation is available at:
+
+https://wiki.libsdl.org/@<@PROJECT_NAME@>@
+
+# Discussions
+
+## Discord
+
+You can join the official Discord server at:
+
+https://discord.com/invite/BwpFGBWsv8
+
+## Forums/mailing lists
+
+You can join SDL development discussions at:
+
+https://discourse.libsdl.org/
+
+Once you sign up, you can use the forum through the website or as a mailing list from your email client.
+
+## Announcement list
+
+You can sign up for the low traffic announcement list at:
+
+https://www.libsdl.org/mailing-list.php
+
diff --git a/build-scripts/pkg-support/msvc/INSTALL.md.in b/build-scripts/pkg-support/msvc/INSTALL.md.in
new file mode 100644
index 00000000..c0c8e4c6
— /dev/null
+++ b/build-scripts/pkg-support/msvc/INSTALL.md.in
@@ -0,0 +1,39 @@
+
+# Using this package
+
+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 @<@PROJECT_NAME@>@.lib to Linker → Input → “Additional Dependencies”
± Copy lib/arch/@<@PROJECT_NAME@>@.dll to your project directory.
+
+# Documentation
+
+An API reference and additional documentation is available at:
+
+https://wiki.libsdl.org/@<@PROJECT_NAME@>@
+
+# Discussions
+
+## Discord
+
+You can join the official Discord server at:
+
+https://discord.com/invite/BwpFGBWsv8
+
+## Forums/mailing lists
+
+You can join SDL development discussions at:
+
+https://discourse.libsdl.org/
+
+Once you sign up, you can use the forum through the website or as a mailing list from your email client.
+
+## Announcement list
+
+You can sign up for the low traffic announcement list at:
+
+https://www.libsdl.org/mailing-list.php
+
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 00000000..c185171a
— /dev/null
+++ b/build-scripts/pkg-support/msvc/arm64/INSTALL.md.in
@@ -0,0 +1,13 @@
+
+# Using this package
+
+This package contains @<@PROJECT_NAME@>@ built for arm64 Windows.
+
+To use this package, simply replace an existing 64-bit ARM @<@PROJECT_NAME@>@.dll with the one included here.
+
+# Development packages
+
+If you’re looking for packages with headers and libraries, you can download one of these:
± @<@PROJECT_NAME@>@-devel-@<@PROJECT_VERSION@>@-VC.zip, for development using Visual Studio
± @<@PROJECT_NAME@>@-devel-@<@PROJECT_VERSION@>@-mingw.zip, for development using mingw-w64
+
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 00000000..22466746
— /dev/null
+++ b/build-scripts/pkg-support/msvc/x64/INSTALL.md.in
@@ -0,0 +1,15 @@
+
+# Using this package
+
+This package contains @<@PROJECT_NAME@>@ built for x64 Windows.
+
+To use this package, simply replace an existing 64-bit @<@PROJECT_NAME@>@.dll with the one included here.
+
+You can include support for additional image formats by including the license and DLL files in the optional directory in your application. They will be automatically loaded by SDL_image as needed.
+
+# Development packages
+
+If you’re looking for packages with headers and libraries, you can download one of these:
± @<@PROJECT_NAME@>@-devel-@<@PROJECT_VERSION@>@-VC.zip, for development using Visual Studio
± @<@PROJECT_NAME@>@-devel-@<@PROJECT_VERSION@>@-mingw.zip, for development using mingw-w64
+
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 00000000..f1bc9928
— /dev/null
+++ b/build-scripts/pkg-support/msvc/x86/INSTALL.md.in
@@ -0,0 +1,15 @@
+
+# Using this package
+
+This package contains @<@PROJECT_NAME@>@ built for x86 Windows.
+
+To use this package, simply replace an existing 32-bit @<@PROJECT_NAME@>@.dll with the one included here.
+
+You can include support for additional image formats by including the license and DLL files in the optional directory in your application. They will be automatically loaded by SDL_image as needed.
+
+# Development packages
+
+If you’re looking for packages with headers and libraries, you can download one of these:
± @<@PROJECT_NAME@>@-devel-@<@PROJECT_VERSION@>@-VC.zip, for development using Visual Studio
± @<@PROJECT_NAME@>@-devel-@<@PROJECT_VERSION@>@-mingw.zip, for development using mingw-w64
+
diff --git a/build-scripts/release-info.json b/build-scripts/release-info.json
index 603f2901..d2286918 100644
— a/build-scripts/release-info.json
+++ b/build-scripts/release-info.json
@@ -44,9 +44,10 @@
},
“files”: {
“”: [
-
"build-scripts/pkg-support/mingw/INSTALL.md.in:INSTALL.md", -
"build-scripts/pkg-support/mingw/Makefile" "LICENSE.txt", "README.md",
-
"build-scripts/pkg-support/mingw/Makefile" ], "cmake": [ "build-scripts/pkg-support/mingw/cmake/SDL3_netConfig.cmake",
@@ -108,11 +109,14 @@
},
“files-lib”: {
“”: [
-
"build-scripts/pkg-support/msvc/@<@ARCH@>@/INSTALL.md.in:INSTALL.md", -
},"LICENSE.txt", "README.md" ]
“files-devel”: {
“”: [ -
"build-scripts/pkg-support/msvc/INSTALL.md.in:INSTALL.md", "LICENSE.txt", "README.md" ],
@@ -188,7 +192,9 @@
},
“files”: {
“”: [
-
"build-scripts/pkg-support/android/README.md.in:README.md"
-
"build-scripts/pkg-support/android/INSTALL.md.in:INSTALL.md", -
"LICENSE.txt", -
},"README.md" ]
“dependencies”: {