From 662ad44a3401566f3fdf059d50935704915d4d10 Mon Sep 17 00:00:00 2001 From: Sam Lantinga Date: Wed, 15 Jan 2025 17:28:03 -0800 Subject: [PATCH] Updated the Android release archive --- .../android/{README.md.in => INSTALL.md.in} | 50 ++++++++++++------- build-scripts/release-info.json | 3 +- 2 files changed, 34 insertions(+), 19 deletions(-) rename build-scripts/pkg-support/android/{README.md.in => INSTALL.md.in} (63%) 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 4314b748020317..602677335bcc70 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 SDL built for the Android platform. ## Gradle integration @@ -65,13 +55,37 @@ python @<@PROJECT_NAME@>@-@<@PROJECT_VERSION@>@.aar -o android_prefix ``` Add `--help` for a list of all available options. +# Documentation + +An API reference, tutorials, and additional documentation is available at: + +https://wiki.libsdl.org/SDL3 + +# Example code + +There are simple example programs available at: + +https://examples.libsdl.org/SDL3 + +# 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 diff --git a/build-scripts/release-info.json b/build-scripts/release-info.json index 5e0d1af24aee5f..dc0bd31b30b30f 100644 --- a/build-scripts/release-info.json +++ b/build-scripts/release-info.json @@ -201,8 +201,9 @@ }, "files": { "": [ + "build-scripts/pkg-support/android/INSTALL.md.in:INSTALL.md", "LICENSE.txt", - "build-scripts/pkg-support/android/README.md.in:README.md" + "README.md" ] } }