aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDon Turner <donturner@google.com>2017-09-05 14:52:39 +0100
committerDon Turner <donturner@google.com>2017-09-05 14:52:39 +0100
commitca6f91a336959ee07df571057aa06ef05b96d636 (patch)
tree48b582977a22314cf9540cf2abdd3ab3551d6aa0 /README.md
parent281900b5b38ac95c8c8d13df584907af65d62c00 (diff)
downloadoboe-ca6f91a336959ee07df571057aa06ef05b96d636.tar.gz
Initial commit
Diffstat (limited to 'README.md')
-rwxr-xr-xREADME.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100755
index 00000000..21f73665
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# oboe
+
+## Introduction
+
+Oboe is a C++ wrapper for the AAudio and OpenSL ES audio APIs on Android.
+
+A program written using Oboe can run on multiple versions of Android.
+On O or later versions, Oboe can use Audio or OpenSL ES.
+On N or earlier versions, Oboe will only use OpenSL ES.
+
+This is not an official Google product.
+
+## Apps
+
+Hello Oboe - simple tone generator
+
+Native MIDI Synth - A MIDI synthesizer that renders in C++ and calls Oboe.
+It uses the Android MIDI API in Java.
+
+## How to Use
+
+Include this as a sub-module in your Git project.
+