diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 39 |
1 files changed, 5 insertions, 34 deletions
@@ -20,44 +20,13 @@ A port is a subclass of the abstract Kotlin class `com.android.ndkports.Port`. Projects define the name and version of the port, the URL to fetch source from, a list of modules (libraries) to build, and the build steps. -```kotlin -abstract class Port { - abstract val name: String - abstract val version: String - abstract val url: String - - open val dependencies: List<String> = emptyList() - abstract val modules: List<Module> - - open fun fetchSource( - sourceDirectory: File, - workingDirectory: File - ): Result<Unit, String> - - open fun configure( - toolchain: Toolchain, - sourceDirectory: File, - buildDirectory: File, - installDirectory: File, - workingDirectory: File - ): Result<Unit, String> - - open fun build( - toolchain: Toolchain, - buildDirectory: File - ): Result<Unit, String> - - open fun install( - toolchain: Toolchain, - buildDirectory: File, - installDirectory: File - ): Result<Unit, String> -} -``` +See the [Port class] for documentation on the port API. Individual port files are kept in `ports/$name/port.kts`. For example, the cURL port is [ports/curl/port.kts](ports/curl/port.kts). +[Port class]: src/main/kotlin/com/android/ndkports/Port.kt + ## Building a Port ndkports requires an NDK to be used for building to be specified on the command @@ -72,3 +41,5 @@ $ find -name '*.aar' ``` Note that dependencies currently need to be already built or ordered explicitly. + +To build all ports using Docker, use `scripts/build.sh`. |