Skip to content

Commit

Permalink
Update documentation to mention Swift support and runAll task.
Browse files Browse the repository at this point in the history
  • Loading branch information
adammurdoch committed May 23, 2024
1 parent ee237fe commit a0d7896
Show file tree
Hide file tree
Showing 6 changed files with 50 additions and 27 deletions.
9 changes: 5 additions & 4 deletions docs/getting-started/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,17 @@ To get started, follow the steps in [this guide](../android/README.md#3-getting-

At the moment, we do not have a detailed guide for other project types.
They are coming soon.
For now, you can check out the [Declarative Gradle prototypes](../../early-prototypes/README.md).
For now, you can check out the [Declarative Gradle prototypes](../../unified-prototypes/README.md).
They include samples and built-in documentation so that you can try them out.
It might be too early to adopt them in your projects due to the upcoming compatibility breaking changes,
but your're welcome to try Declarative Gradle in non-production projects and experimental branches.
but you're welcome to try Declarative Gradle in non-production projects and experimental branches.

- [Declarative Gradle for Java](../../unified-prototype/README.md#java)
- [Declarative Gradle for Kotlin](../../unified-prototype/README.md#kotlin-jvm)
- [Declarative Gradle for Kotlin JVM](../../unified-prototype/README.md#kotlin-jvm)
- [Declarative Gradle for Kotlin Multiplatform (KMP)](../../unified-prototype/README.md#kotlin-kmp)
- [Declarative Gradle for Swift](../../unified-prototype/README.md#swift)

## References

- [Support for Android](../android/README.md)
- [Other Declarative Gradle prototypes](../../early-prototypes/README.md)
- [Other Declarative Gradle prototypes](../../unified-prototypes/README.md)
1 change: 1 addition & 0 deletions docs/java/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,4 @@ javaApplication {

- [Declarative Gradle for Kotlin](../kotlin/README.md)
- [Declarative Gradle for Android](../android/README.md)
- [Declarative Gradle for Swift](../swift/README.md)
14 changes: 8 additions & 6 deletions docs/kotlin/README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,24 @@
---
title: Declarative Gradle for Kotlin
description: >
Declarative Gradle has solution for Kotlin projects, libraries and
also for Kotlin Multiplatform applications.
Declarative Gradle has solution for Kotlin application and libraries
---

Declarative Gradle has solution for Kotlin projects, libraries and
also for Kotlin Multiplatform (KMP) applications.
Declarative Gradle has solution for Kotlin JVM application and libraries and
also for Kotlin Multiplatform (KMP) applications and libraries.

> **DISCLAIMER:** This page is under development, more content will be added soon.
> For now, check out the prototypes referenced below.
## Prototypes

- [Kotlin Application](../../unified-prototype/testbed-kotlin-application/)
- [Kotlin Library](../../unified-prototype/testbed-kotlin-library/)
- [Kotlin JVM Application](../../unified-prototype/testbed-kotlin-jvm-application/)
- [Kotlin JVM Library](../../unified-prototype/testbed-kotlin-jvm-library/)
- [Kotlin Multiplatform Application](../../unified-prototype/testbed-kotlin-application/)
- [Kotlin Multiplatform Library](../../unified-prototype/testbed-kotlin-library/)

## References

- [Declarative Gradle for Java](../java/README.md)
- [Declarative Gradle for Android](../android/README.md)
- [Declarative Gradle for Swift](../swift/README.md)
21 changes: 21 additions & 0 deletions docs/swift/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Declarative Gradle for Swift
description: >
Declarative Gradle has solution for Swift
---

Declarative Gradle has solution for Swift applications and libraries.

> **DISCLAIMER:** This page is under development, more content will be added soon.
> For now, check out the prototypes referenced below.
## Prototypes

- [Swift Application](../../unified-prototype/testbed-swift-application/)
- [Swift Library](../../unified-prototype/testbed-swift-library/)

## References

- [Declarative Gradle for Java](../java/README.md)
- [Declarative Gradle for Kotlin](../kotlin/README.md)
- [Declarative Gradle for Android](../android/README.md)
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ nav:
Declarative Gradle for Android: docs/android/README.md
Declarative Gradle for Java/JVM: docs/java/README.md
Declarative Gradle for Kotlin: docs/kotlin/README.md
Declarative Gradle for Swift: docs/swift/README.md
Public Roadmap: ROADMAP.md
- Getting Started:
Overview: docs/getting-started/README.md
Expand Down
31 changes: 14 additions & 17 deletions unified-prototype/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ These samples show the definition of a simple Java application and library that

To run the application, use:

```
> ./gradlew testbed-java-application:run
```shell
> ./gradlew testbed-java-application:runAll
```

## JVM
Expand All @@ -24,8 +24,8 @@ These samples show the definition of a simple Java application and library that

To run the application, use:

```
> ./gradlew testbed-java-application:run
```shell
> ./gradlew testbed-jvm-application:runAll
```

## Kotlin JVM
Expand All @@ -36,8 +36,8 @@ These samples show the definition of a simple Kotlin JVM application and library

To run the application, use:

```
> ./gradlew testbed-kotlin-jvm-application:run
```shell
> ./gradlew testbed-kotlin-jvm-application:runAll
```

## Kotlin Multiplatform
Expand All @@ -48,25 +48,16 @@ The `unified-prototype/plugin-kmp` plugin demonstrates creating extensions using

The sample project demonstrates setting properties, using a common dependencies block, and adding dependencies to specific targets.

### Implementation Notes

An Apache Commons dependency is used by the JVM code.
A SQLDelight dependency is used by the JS code.
The kotlinx.datetime multiplatform dep is used by common code.

The `StandaloneKmpLibraryPlugin` plugin works by using `project.afterEvaluate` to load data from the Declarative DSL extensions into KGP's model.

### Limitations

The KMP example is currently limited, and does not support any targets other than `nodeJs`, `jvm` and `macOsArm64`.

### Running

From the `testbed-kotlin-application` directory, run `jvmRun` using the Gradle wrapper in the parent directory:
To run the application, use:

```shell
cd testbed-kotlin-application
../gradlew jvmRun
../gradlew testbed-kotlin-application:runAll
```

### Building
Expand Down Expand Up @@ -134,3 +125,9 @@ gradlew :testbed-android-application:assembleRelease
## Swift

The sample Swift projects live in the `testbed-swift-library` and `testbed-swift-application` directories.

To run the application, use:

```shell
../gradlew testbed-swift-application:runAll
```

0 comments on commit a0d7896

Please sign in to comment.