Skip to content

Commit

Permalink
Update readme with minimal example
Browse files Browse the repository at this point in the history
  • Loading branch information
desttinghim authored and ikskuh committed Apr 11, 2023
1 parent 4455763 commit a790783
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,18 @@ This repository contains multiple examples of creating a minimal Android app in

## Examples

There are 3 different examples. The examples have no dependencies on C code except for the android libraries, so they can be considered pure Zig apps.
There are 4 different examples. The examples have no dependencies on C code except for the android libraries, so they can be considered pure Zig apps.

To select which example to build and run, pass the example flag (e.g. `-Dexample=egl`). Valid values for the example flag are `egl`, `textview`, and `invocationhandler`.
To select which example to build and run, pass the example flag (e.g. `-Dexample=egl`). Valid values for the example flag are `egl`, `minimal`, `textview`, and `invocationhandler`.

We're running a CI that will verify the build for Windows, macOS and Linux:

[![CI](https://github.com/MasterQ32/ZigAndroidTemplate/actions/workflows/main-ci.yml/badge.svg)](https://github.com/MasterQ32/ZigAndroidTemplate/actions/workflows/main-ci.yml)

### Minimal

`examples/minimal` includes just enough code to get the app running.

### EGL

`examples/egl/` initializes OpenGL and renders a color cycle. Touchscreen events will activate a sine wave synth and be displayed as small circles beneath the fingers that will fade as soon as no event for the same finger will happen again.
Expand Down

0 comments on commit a790783

Please sign in to comment.