mirror of
https://github.com/reactivecircus/android-emulator-runner.git
synced 2026-09-05 03:29:32 +00:00
Update docs.
This commit is contained in:
@@ -1,24 +1,25 @@
|
||||
# GitHub Action - Android Emulator Runner
|
||||
|
||||
<p align="left">
|
||||
<a href="https://github.com/ReactiveCircus/android-emulator-runner"><img alt="GitHub Actions status" src="https://github.com/ReactiveCircus/android-emulator-runner/workflows/Main%20workflow/badge.svg"></a>
|
||||
</p>
|
||||
|
||||
A GitHub Action for installing, configuring and running Android Emulators on macOS virtual machines.
|
||||
|
||||
TODO
|
||||
|
||||
This action must be run on a **macOS** VM, e.g. `macOS-latest` or `macOS-10.14`.
|
||||
|
||||
## Inputs
|
||||
## Configurations
|
||||
|
||||
### `api-level`
|
||||
| **Input** | **Required** | **Default** | **Description** |
|
||||
|-------------|--------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `api-level` | Required | N/A | API level of the platform system image - e.g. 23 for Android Marshmallow, 29 for Android 10. **Minimum API level supported is 21**. |
|
||||
| `target` | Optional | `default` | Target of the system image - `default` or `google_apis`. |
|
||||
| `abi` | Optional | `x86` | CPU / ABI of the system image - `x86` or `x86_64`. |
|
||||
| `headless` | Optional | `true` | Whether to launch emulator without UI - `true` or `false`. When set to `true` this is equivalent to running the emulator with `emulator -no-window`. |
|
||||
|
||||
**Required**
|
||||
|
||||
The API level of the system image to be used for the emulator. E.g. `23` for Android 6.0 Marshmallow, `29` for Android 10.
|
||||
|
||||
**Minimum API level supported is 21**.
|
||||
|
||||
TODO
|
||||
|
||||
## Example usage
|
||||
## Usage
|
||||
|
||||
```
|
||||
TODO
|
||||
|
||||
Reference in New Issue
Block a user