summaryrefslogtreecommitdiff
path: root/src/contrib/SDL-3.2.20/build-scripts/pkg-support/android/INSTALL.md.in
diff options
context:
space:
mode:
Diffstat (limited to 'src/contrib/SDL-3.2.20/build-scripts/pkg-support/android/INSTALL.md.in')
-rw-r--r--src/contrib/SDL-3.2.20/build-scripts/pkg-support/android/INSTALL.md.in91
1 files changed, 91 insertions, 0 deletions
diff --git a/src/contrib/SDL-3.2.20/build-scripts/pkg-support/android/INSTALL.md.in b/src/contrib/SDL-3.2.20/build-scripts/pkg-support/android/INSTALL.md.in
new file mode 100644
index 0000000..80321c2
--- /dev/null
+++ b/src/contrib/SDL-3.2.20/build-scripts/pkg-support/android/INSTALL.md.in
@@ -0,0 +1,91 @@
1
2# Using this package
3
4This package contains @<@PROJECT_NAME@>@ built for the Android platform.
5
6## Gradle integration
7
8For integration with CMake/ndk-build, it uses [prefab](https://google.github.io/prefab/).
9
10Copy the aar archive (@<@PROJECT_NAME@>@-@<@PROJECT_VERSION@>@.aar) to a `app/libs` directory of your project.
11
12In `app/build.gradle` of your Android project, add:
13```
14android {
15 /* ... */
16 buildFeatures {
17 prefab true
18 }
19}
20dependencies {
21 implementation files('libs/@<@PROJECT_NAME@>@-@<@PROJECT_VERSION@>@.aar')
22 /* ... */
23}
24```
25
26If you're using CMake, add the following to your CMakeLists.txt:
27```
28find_package(@<@PROJECT_NAME@>@ REQUIRED CONFIG)
29target_link_libraries(yourgame PRIVATE @<@PROJECT_NAME@>@::@<@PROJECT_NAME@>@)
30```
31
32If you use ndk-build, add the following before `include $(BUILD_SHARED_LIBRARY)` to your `Android.mk`:
33```
34LOCAL_SHARED_LIBARARIES := SDL3 SDL3-Headers
35```
36And add the following at the bottom:
37```
38# https://google.github.io/prefab/build-systems.html
39
40# Add the prefab modules to the import path.
41$(call import-add-path,/out)
42
43# Import @<@PROJECT_NAME@>@ so we can depend on it.
44$(call import-module,prefab/@<@PROJECT_NAME@>@)
45```
46
47---
48
49## Other build systems (advanced)
50
51If you want to build a project without Gradle,
52running the following command will extract the Android archive into a more common directory structure.
53```
54python @<@PROJECT_NAME@>@-@<@PROJECT_VERSION@>@.aar -o android_prefix
55```
56Add `--help` for a list of all available options.
57
58# Documentation
59
60An API reference, tutorials, and additional documentation is available at:
61
62https://wiki.libsdl.org/@<@PROJECT_NAME@>@
63
64# Example code
65
66There are simple example programs available at:
67
68https://examples.libsdl.org/SDL3
69
70# Discussions
71
72## Discord
73
74You can join the official Discord server at:
75
76https://discord.com/invite/BwpFGBWsv8
77
78## Forums/mailing lists
79
80You can join SDL development discussions at:
81
82https://discourse.libsdl.org/
83
84Once you sign up, you can use the forum through the website or as a mailing list from your email client.
85
86## Announcement list
87
88You can sign up for the low traffic announcement list at:
89
90https://www.libsdl.org/mailing-list.php
91