Skip to content

Commit

Permalink
[Docu] Updated documentation how to build LLGL for Android.
Browse files Browse the repository at this point in the history
Also added docu/Showcase/ folder with example screenshot of LLGL project in Android Studio.
  • Loading branch information
LukasBanana committed Aug 4, 2024
1 parent a6c6202 commit b174c91
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion docu/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@

## CMake

The primary build tool for LLGL is [CMake](https://cmake.org/) and while LLGL is compatible with older versions down to version 3.7, it is recommended to use a more up to date version, i.e. 3.18 and later.
The primary build tool for LLGL is [CMake](https://cmake.org/) and while LLGL is compatible with older versions down to version 3.7,
it is recommended to use a more up to date version, i.e. 3.18 and later. You can either use the CMake GUI, run the cmake command manually,
or run the *Build* script for the respective platform (run them with `-h`/`--help` for more details).


## Windows
Expand All @@ -23,6 +25,20 @@ It is recommended to use a higher version of [Xcode](https://developer.apple.com
At least version 12 on *macOS 10.15 Catalina* is required to test the Metal backend on the iOS simulator.


## Android

The build script for Android compiles LLGL for one or more ABIs, since Android is available on many different devices.
It can generate the folder structure of all example projects for [Android Studio](https://developer.android.com/studio).
The recommended process to build LLGL examples for Android can be split into two steps:
1. Run `./BuildAndroid.sh --apps` (additional arguents are optional), which compiles LLGL for the default ABIs (arm64-v8a, armeabi-v7a, x86, x86_64).
2. Open the respective example directory (*<LLGL-ROOT>/build_android/apps/<EXAMPLE>*) in Android Studio to build and run the app in either a simulator or on your Android device.
On Windows, MSYS2 can be used to run *BuildAndroid.sh*.

<p align="center">
<img src="Showcase/Showcase_Build_AndroidStudio.png" alt="Screenshot missing: AndroidStudio Build Showcase" style="width:400px;height:auto;">
</p>


## GNU/Linux

The `BuildLinux.sh` script recognizes several major Linux distributions.
Expand Down
Binary file added docu/Showcase/Showcase_Build_AndroidStudio.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b174c91

Please sign in to comment.