Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README: Document tested and supported NDK versions #159

Merged
merged 3 commits into from
Jul 27, 2021
+18 −7
Merged

README: Document tested and supported NDK versions #159

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
41301fc
README: Document tested and supported NDK versions
MarijnS95 Jul 24, 2021
5f52720
README: Remove empty `TODO` headers
MarijnS95 Jul 24, 2021
f93d319
Update README.md
MarijnS95 Jul 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 18 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Rust on Android
Rust on Android
=

[![Rust](https://github.com/rust-windowing/android-ndk-rs/workflows/Rust/badge.svg)](https://github.com/rust-windowing/android-ndk-rs/actions) ![MIT license](https://img.shields.io/badge/License-MIT-green.svg) ![APACHE2 license](https://img.shields.io/badge/License-APACHE2-green.svg)

Expand All @@ -14,6 +15,22 @@ Name | Description | Badges

See [`ndk-examples`](./ndk-examples) for examples using the NDK and the README files of the crates for more details.

## Supported NDK versions

`android-ndk-rs` aims to support at least the `LTS` and `Rolling Release` branches of the NDK, as described on [their wiki](https://github.com/android/ndk/wiki#supported-downloads). Additionally the `Beta Release` might be supported to prepare for an upcoming release.

As of writing (2021-07-24) the following NDKs are tested:

Branch | Version | Status | Working
-|-|:-:|:-:
r18 | 18.1.5063045 | _Deprecated_ | :x:
r19 | 19.2.5345600 | _Deprecated_ | :heavy_check_mark:
r20 | 20.1.5948944 | _Deprecated_ | :heavy_check_mark:
r21 | 21.4.7075529 | LTS | :heavy_check_mark:
r22 | 22.1.7171670 | Rolling Release | :heavy_check_mark:
r23 beta 1/2 | | Beta | :heavy_check_mark:
r23 beta 3 and beyond | | Beta | :x: Breaking on https://github.com/rust-windowing/android-ndk-rs/issues/149 :x:
MarijnS95 marked this conversation as resolved.
Show resolved Hide resolved

## Hello world

Quick start for setting up a new project with support for Android. For communication with the Android framework in our native Rust application we require a `NativeActivity`. `ndk-glue` will do the necessary initialization when calling `main` but requires a few adjustments:
Expand Down Expand Up @@ -87,9 +104,3 @@ Java Native Interface (JNI) allows executing Java code in a VM from native appli
`ndk-examples` contains an `jni_audio` example which will print out all output audio devices in the log.

- [`jni`](https://crates.io/crates/jni), JNI bindings for Rust

## Winit and glutin
TODO shameless plug

## Flutter
TODO shameless plug