Browse Source

Update README.md for examples (#2990)

pull/2996/head
Nikita Lipsky 1 year ago committed by GitHub
parent
commit
5e7d55fb33
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 12
      examples/chat/README.md
  2. BIN
      examples/chat/run-configurations.png
  3. 33
      examples/falling-balls/README.md
  4. BIN
      examples/falling-balls/run-configurations.png
  5. 14
      examples/imageviewer/README.md
  6. BIN
      examples/imageviewer/screenshots/run-configurations.png
  7. 12
      examples/minesweeper/README.md
  8. BIN
      examples/minesweeper/run-configurations.png
  9. 13
      examples/todoapp-lite/README.md
  10. BIN
      examples/todoapp-lite/run-configurations.png
  11. 14
      examples/visual-effects/README.md
  12. BIN
      examples/visual-effects/run-configurations.png
  13. 12
      examples/widgets-gallery/README.md
  14. BIN
      examples/widgets-gallery/run-configurations.png

12
examples/chat/README.md

@ -7,22 +7,16 @@ This file helps to add Compose inside SwiftUI hierarchy.
Example can run on Android, iOS, desktop or in a browser.
*Prerequisites*: to run on iOS and Android, you should have "Kotlin Multiplatform Mobile" plugin installed either
in Android Studio or in AppCode with [installed CocoaPods](https://kotlinlang.org/docs/native-cocoapods.html).
## Setting up your development environment
To setup the environment, please consult these [instructions](https://github.com/JetBrains/compose-multiplatform-template#setting-up-your-development-environment).
## How to run
Choose a run configuration for an appropriate target in IDE and run it.
Choose a run configuration for an appropriate target in Android Studio and run it.
![run-configurations.png](run-configurations.png)
To run on iOS device, please correct `TEAM_ID` value in `iosApp/Configuration/Config.xcconfig` with your Apple Team ID.
Alternatively, you may setup signing within XCode opening `iosApp/iosApp.xcworkspace` and then
using "Signing & Capabilities" tab of `iosApp` target.
Then choose **iosApp** configuration in IDE and run it.
## Run on desktop via Gradle
`./gradlew desktopApp:run`

BIN
examples/chat/run-configurations.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 20 KiB

33
examples/falling-balls/README.md

@ -2,22 +2,16 @@
Game can run on Android, iOS, desktop or in a browser.
*Prerequisites*: to run on iOS and Android, you should have "Kotlin Multiplatform Mobile" plugin installed either
in Android Studio or in AppCode with [installed CocoaPods](https://kotlinlang.org/docs/native-cocoapods.html).
## Setting up your development environment
To setup the environment, please consult these [instructions](https://github.com/JetBrains/compose-multiplatform-template#setting-up-your-development-environment).
## How to run
Choose a run configuration for an appropriate target in IDE and run it.
Choose a run configuration for an appropriate target in Android Studio and run it.
![run-configurations.png](run-configurations.png)
To run on iOS device, please correct `TEAM_ID` value in `iosApp/Configuration/Config.xcconfig` with your Apple Team ID.
Alternatively, you may setup signing within XCode opening `iosApp/iosApp.xcworkspace` and then
using "Signing & Capabilities" tab of `iosApp` target. See also how to prepare XCode section below.
Then choose **iosApp** configuration in IDE and run it.
## Run on desktop via Gradle
`./gradlew desktopApp:run`
@ -26,27 +20,6 @@ Then choose **iosApp** configuration in IDE and run it.
`./gradlew jsApp:jsBrowserDevelopmentRun`
## Prepare Xcode to launch on iOS device
1) **Add your Apple ID.**
Xcode -> Preferences... -> Accounts
![apple-id.png](apple-id.png)
2) **Create certificates with XCode in temporary project.**
You can create a certificate in Xcode. Create a new iOS app in Xcode.
File -> New -> Project
Choose iOS, App:
![ios-app.png](ios-app.png)
3) **In next dialog set any product name and choose your teamID.**
4) **Run project on iOS Device.**
Xcode prompts you to install the certificate. Require password from login.keychain
5) **Done**
After a successful launch on the device - you can delete this temporary project.
Certificates will remain in login.keychain
## Run native on MacOS
Choose **shared[macosX64]** or **shared[macosArm64]** configuration in IDE and run it.

BIN
examples/falling-balls/run-configurations.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 20 KiB

14
examples/imageviewer/README.md

@ -1,7 +1,11 @@
# Imageviewer
An example of image gallery for remote server image viewing,
based on Compose Multiplatform UI library (desktop, android and iOS).
An example of an image gallery with camera and map support
based on Compose Multiplatform (desktop, Android and iOS).
## Setting up your development environment
To setup the environment, please consult these [instructions](https://github.com/JetBrains/compose-multiplatform-template#setting-up-your-development-environment).
## How to run
@ -9,12 +13,6 @@ Choose a run configuration for an appropriate target in IDE and run it.
![run-configurations.png](screenshots/run-configurations.png)
To run on iOS device, please correct `TEAM_ID` value in `iosApp/Configuration/Config.xcconfig` with your Apple Team ID.
Alternatively, you may setup signing within XCode opening `iosApp/iosApp.xcworkspace` and then
using "Signing & Capabilities" tab of `iosApp` target.
Then choose **iosApp** configuration in IDE and run it.
## Run on desktop via Gradle
`./gradlew desktopApp:run`

BIN
examples/imageviewer/screenshots/run-configurations.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 17 KiB

12
examples/minesweeper/README.md

@ -4,22 +4,16 @@ A simple game powered by Compose Multiplatform.
Game can run on Android, iOS, desktop or in a browser.
*Prerequisites*: to run on iOS and Android, you should have "Kotlin Multiplatform Mobile" plugin installed either
in Android Studio or in AppCode with [installed CocoaPods](https://kotlinlang.org/docs/native-cocoapods.html).
## Setting up your development environment
To setup the environment, please consult these [instructions](https://github.com/JetBrains/compose-multiplatform-template#setting-up-your-development-environment).
## How to run
Choose a run configuration for an appropriate target in IDE and run it.
Choose a run configuration for an appropriate target in Android Studio and run it.
![run-configurations.png](run-configurations.png)
To run on iOS device, please correct `TEAM_ID` value in `iosApp/Configuration/Config.xcconfig` with your Apple Team ID.
Alternatively, you may setup signing within XCode opening `iosApp/iosApp.xcworkspace` and then
using "Signing & Capabilities" tab of `iosApp` target.
Then choose **iosApp** configuration in IDE and run it.
## Run on desktop via Gradle
`./gradlew desktopApp:run`

BIN
examples/minesweeper/run-configurations.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 20 KiB

13
examples/todoapp-lite/README.md

@ -4,18 +4,15 @@ A simplified version of the [TodoApp example](https://github.com/JetBrains/compo
Supported targets: Android, Desktop and iOS.
## How to run
Choose a run configuration for an appropriate target in IDE and run it.
## Setting up your development environment
![run-configurations.png](run-configurations.png)
To setup the environment, please consult these [instructions](https://github.com/JetBrains/compose-multiplatform-template#setting-up-your-development-environment).
To run on iOS device, please correct `TEAM_ID` value in `iosApp/Configuration/Config.xcconfig` with your Apple Team ID.
Alternatively, you may setup signing within XCode opening `iosApp/iosApp.xcworkspace` and then
using "Signing & Capabilities" tab of `iosApp` target.
## How to run
Then choose **iosApp** configuration in IDE and run it.
Choose a run configuration for an appropriate target in Android Studio and run it.
![run-configurations.png](run-configurations.png)
## Run on desktop via Gradle

BIN
examples/todoapp-lite/run-configurations.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 17 KiB

14
examples/visual-effects/README.md

@ -2,22 +2,18 @@
Several visual effects implemented with Compose Multiplatform, used in 1.0 release announce video.
*Prerequisites*: to run on iOS and Android, you should have "Kotlin Multiplatform Mobile" plugin installed either
in Android Studio or in AppCode with [installed CocoaPods](https://kotlinlang.org/docs/native-cocoapods.html).
Supported targets: Android, Desktop and iOS.
## Setting up your development environment
To setup the environment, please consult these [instructions](https://github.com/JetBrains/compose-multiplatform-template#setting-up-your-development-environment).
## How to run
Choose a run configuration for an appropriate target in IDE and run it.
Choose a run configuration for an appropriate target in Android Studio and run it.
![run-configurations.png](run-configurations.png)
To run on iOS device, please correct `TEAM_ID` value in `iosApp/Configuration/Config.xcconfig` with your Apple Team ID.
Alternatively, you may setup signing within XCode opening `iosApp/iosApp.xcworkspace` and then
using "Signing & Capabilities" tab of `iosApp` target.
Then choose **iosApp** configuration in IDE and run it.
## Run on desktop via Gradle
`./gradlew desktopApp:run`

BIN
examples/visual-effects/run-configurations.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 17 KiB

12
examples/widgets-gallery/README.md

@ -8,17 +8,15 @@ published under [MIT license](third_party/ComposeCookBook_LICENSE.txt).
An example of Compose application for Desktop, Android and iOS platforms,
demonstrating how to use various Material widgets.
## How to run
## Setting up your development environment
Choose a run configuration for an appropriate target in IDE and run it.
To setup the environment, please consult these [instructions](https://github.com/JetBrains/compose-multiplatform-template#setting-up-your-development-environment).
![run-configurations.png](run-configurations.png)
## How to run
To run on iOS device, please correct `TEAM_ID` value in `iosApp/Configuration/Config.xcconfig` with your Apple Team ID.
Alternatively, you may setup signing within XCode opening `iosApp/iosApp.xcworkspace` and then
using "Signing & Capabilities" tab of `iosApp` target.
Choose a run configuration for an appropriate target in Android Studio and run it.
Then choose **iosApp** configuration in IDE and run it.
![run-configurations.png](run-configurations.png)
## Run on desktop via Gradle

BIN
examples/widgets-gallery/run-configurations.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 17 KiB

Loading…
Cancel
Save