Skip to content

Commit

Permalink
chore(config): more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chicoxyzzy committed Apr 18, 2023
1 parent 2f5d928 commit e747a4e
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 0 deletions.
21 changes: 21 additions & 0 deletions api/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ allow_cleartext | | Allow unencrypted http requests, useful for live reload.
enable_standard_ndk_build | | Enables gradle based ndk build rather than using external native build (standard ndk is the old slow way)
main_activity | | Name of the MainActivity class. Could be overwritten by custom native code.
manifest_permissions | | Which permissions does your application need: https://developer.android.com/guide/topics/permissions/overview
native_cflags | | Used for adding custom source files and related compiler attributes.
native_sources | |
native_makefile | |
sources | |

## Section `ios`

Expand Down Expand Up @@ -91,3 +95,20 @@ Key | Default Value | Description
height | | The initial height of the first window.
width | | The initial width of the first window.

## Section `headless`

Key | Default Value | Description
:--- | :--- | :---
runner | | The headless runner command. It is used when no OS specific runner is set.
runner_flags | | The headless runner command flags. It is used when no OS specific runner is set.
runner_android | | The headless runner command for Android
runner_android_flags | | The headless runner command flags for Android
runner_ios | | The headless runner command for iOS
runner_ios_flags | | The headless runner command flags for iOS
runner_linux | | The headless runner command for Linux
runner_linux_flags | | The headless runner command flags for Linux
runner_mac | | The headless runner command for MacOS
runner_mac_flags | | The headless runner command flags for MacOS
runner_win32 | | The headless runner command for Windows
runner_win32_flags | | The headless runner command flags for Windows

33 changes: 33 additions & 0 deletions src/cli/templates.hh
Original file line number Diff line number Diff line change
Expand Up @@ -1437,6 +1437,11 @@ main_activity = ""
; Which permissions does your application need: https://developer.android.com/guide/topics/permissions/overview
manifest_permissions = ""
; Used for adding custom source files and related compiler attributes.
native_cflags = ""
native_sources = ""
native_makefile = ""
sources = ""
[ios]
Expand Down Expand Up @@ -1521,6 +1526,34 @@ height = 50%
; The initial width of the first window.
width = 50%
[headless]
; The headless runner command. It is used when no OS specific runner is set.
runner = ""
; The headless runner command flags. It is used when no OS specific runner is set.
runner_flags = ""
; The headless runner command for Android
runner_android = ""
; The headless runner command flags for Android
runner_android_flags = ""
; The headless runner command for iOS
runner_ios = ""
; The headless runner command flags for iOS
runner_ios_flags = ""
; The headless runner command for Linux
runner_linux = ""
; The headless runner command flags for Linux
runner_linux_flags = ""
; The headless runner command for MacOS
runner_mac = ""
; The headless runner command flags for MacOS
runner_mac_flags = ""
; The headless runner command for Windows
runner_win32 = ""
; The headless runner command flags for Windows
runner_win32_flags = ""
)INI";
constexpr auto gDefaultGitignore = R"GITIGNORE(
Expand Down

0 comments on commit e747a4e

Please sign in to comment.