Skip to content

Commit 5e7d55f

Browse files
authoredApr 5, 2023
Update README.md for examples (JetBrains#2990)
1 parent 6f13bc3 commit 5e7d55f

File tree

14 files changed

+30
-80
lines changed

14 files changed

+30
-80
lines changed
 

‎examples/chat/README.md

+3-9
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,16 @@ This file helps to add Compose inside SwiftUI hierarchy.
77

88
Example can run on Android, iOS, desktop or in a browser.
99

10-
*Prerequisites*: to run on iOS and Android, you should have "Kotlin Multiplatform Mobile" plugin installed either
11-
in Android Studio or in AppCode with [installed CocoaPods](https://kotlinlang.org/docs/native-cocoapods.html).
10+
## Setting up your development environment
1211

12+
To setup the environment, please consult these [instructions](https://github.com/JetBrains/compose-multiplatform-template#setting-up-your-development-environment).
1313

1414
## How to run
1515

16-
Choose a run configuration for an appropriate target in IDE and run it.
16+
Choose a run configuration for an appropriate target in Android Studio and run it.
1717

1818
![run-configurations.png](run-configurations.png)
1919

20-
To run on iOS device, please correct `TEAM_ID` value in `iosApp/Configuration/Config.xcconfig` with your Apple Team ID.
21-
Alternatively, you may setup signing within XCode opening `iosApp/iosApp.xcworkspace` and then
22-
using "Signing & Capabilities" tab of `iosApp` target.
23-
24-
Then choose **iosApp** configuration in IDE and run it.
25-
2620
## Run on desktop via Gradle
2721

2822
`./gradlew desktopApp:run`

‎examples/chat/run-configurations.png

-1.13 KB
Loading

‎examples/falling-balls/README.md

+3-30
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,16 @@
22

33
Game can run on Android, iOS, desktop or in a browser.
44

5-
*Prerequisites*: to run on iOS and Android, you should have "Kotlin Multiplatform Mobile" plugin installed either
6-
in Android Studio or in AppCode with [installed CocoaPods](https://kotlinlang.org/docs/native-cocoapods.html).
5+
## Setting up your development environment
76

7+
To setup the environment, please consult these [instructions](https://github.com/JetBrains/compose-multiplatform-template#setting-up-your-development-environment).
88

99
## How to run
1010

11-
Choose a run configuration for an appropriate target in IDE and run it.
11+
Choose a run configuration for an appropriate target in Android Studio and run it.
1212

1313
![run-configurations.png](run-configurations.png)
1414

15-
To run on iOS device, please correct `TEAM_ID` value in `iosApp/Configuration/Config.xcconfig` with your Apple Team ID.
16-
Alternatively, you may setup signing within XCode opening `iosApp/iosApp.xcworkspace` and then
17-
using "Signing & Capabilities" tab of `iosApp` target. See also how to prepare XCode section below.
18-
19-
Then choose **iosApp** configuration in IDE and run it.
20-
2115
## Run on desktop via Gradle
2216

2317
`./gradlew desktopApp:run`
@@ -26,27 +20,6 @@ Then choose **iosApp** configuration in IDE and run it.
2620

2721
`./gradlew jsApp:jsBrowserDevelopmentRun`
2822

29-
## Prepare Xcode to launch on iOS device
30-
31-
1) **Add your Apple ID.**
32-
Xcode -> Preferences... -> Accounts
33-
![apple-id.png](apple-id.png)
34-
35-
2) **Create certificates with XCode in temporary project.**
36-
You can create a certificate in Xcode. Create a new iOS app in Xcode.
37-
File -> New -> Project
38-
Choose iOS, App:
39-
![ios-app.png](ios-app.png)
40-
41-
3) **In next dialog set any product name and choose your teamID.**
42-
43-
4) **Run project on iOS Device.**
44-
Xcode prompts you to install the certificate. Require password from login.keychain
45-
46-
5) **Done**
47-
After a successful launch on the device - you can delete this temporary project.
48-
Certificates will remain in login.keychain
49-
5023
## Run native on MacOS
5124
Choose **shared[macosX64]** or **shared[macosArm64]** configuration in IDE and run it.
5225

-1.13 KB
Loading

‎examples/imageviewer/README.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11
# Imageviewer
22

3-
An example of image gallery for remote server image viewing,
4-
based on Compose Multiplatform UI library (desktop, android and iOS).
3+
An example of an image gallery with camera and map support
4+
based on Compose Multiplatform (desktop, Android and iOS).
5+
6+
## Setting up your development environment
7+
8+
To setup the environment, please consult these [instructions](https://github.com/JetBrains/compose-multiplatform-template#setting-up-your-development-environment).
59

610
## How to run
711

812
Choose a run configuration for an appropriate target in IDE and run it.
913

1014
![run-configurations.png](screenshots/run-configurations.png)
1115

12-
To run on iOS device, please correct `TEAM_ID` value in `iosApp/Configuration/Config.xcconfig` with your Apple Team ID.
13-
Alternatively, you may setup signing within XCode opening `iosApp/iosApp.xcworkspace` and then
14-
using "Signing & Capabilities" tab of `iosApp` target.
15-
16-
Then choose **iosApp** configuration in IDE and run it.
17-
1816
## Run on desktop via Gradle
1917

2018
`./gradlew desktopApp:run`
Loading

‎examples/minesweeper/README.md

+3-9
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,16 @@ A simple game powered by Compose Multiplatform.
44

55
Game can run on Android, iOS, desktop or in a browser.
66

7-
*Prerequisites*: to run on iOS and Android, you should have "Kotlin Multiplatform Mobile" plugin installed either
8-
in Android Studio or in AppCode with [installed CocoaPods](https://kotlinlang.org/docs/native-cocoapods.html).
7+
## Setting up your development environment
98

9+
To setup the environment, please consult these [instructions](https://github.com/JetBrains/compose-multiplatform-template#setting-up-your-development-environment).
1010

1111
## How to run
1212

13-
Choose a run configuration for an appropriate target in IDE and run it.
13+
Choose a run configuration for an appropriate target in Android Studio and run it.
1414

1515
![run-configurations.png](run-configurations.png)
1616

17-
To run on iOS device, please correct `TEAM_ID` value in `iosApp/Configuration/Config.xcconfig` with your Apple Team ID.
18-
Alternatively, you may setup signing within XCode opening `iosApp/iosApp.xcworkspace` and then
19-
using "Signing & Capabilities" tab of `iosApp` target.
20-
21-
Then choose **iosApp** configuration in IDE and run it.
22-
2317
## Run on desktop via Gradle
2418

2519
`./gradlew desktopApp:run`
-1.13 KB
Loading

‎examples/todoapp-lite/README.md

+5-8
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,15 @@ A simplified version of the [TodoApp example](https://github.com/JetBrains/compo
44

55
Supported targets: Android, Desktop and iOS.
66

7-
## How to run
8-
9-
Choose a run configuration for an appropriate target in IDE and run it.
7+
## Setting up your development environment
108

11-
![run-configurations.png](run-configurations.png)
9+
To setup the environment, please consult these [instructions](https://github.com/JetBrains/compose-multiplatform-template#setting-up-your-development-environment).
1210

13-
To run on iOS device, please correct `TEAM_ID` value in `iosApp/Configuration/Config.xcconfig` with your Apple Team ID.
14-
Alternatively, you may setup signing within XCode opening `iosApp/iosApp.xcworkspace` and then
15-
using "Signing & Capabilities" tab of `iosApp` target.
11+
## How to run
1612

17-
Then choose **iosApp** configuration in IDE and run it.
13+
Choose a run configuration for an appropriate target in Android Studio and run it.
1814

15+
![run-configurations.png](run-configurations.png)
1916

2017
## Run on desktop via Gradle
2118

1.68 KB
Loading

‎examples/visual-effects/README.md

+5-9
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,18 @@
22

33
Several visual effects implemented with Compose Multiplatform, used in 1.0 release announce video.
44

5-
*Prerequisites*: to run on iOS and Android, you should have "Kotlin Multiplatform Mobile" plugin installed either
6-
in Android Studio or in AppCode with [installed CocoaPods](https://kotlinlang.org/docs/native-cocoapods.html).
5+
Supported targets: Android, Desktop and iOS.
76

7+
## Setting up your development environment
8+
9+
To setup the environment, please consult these [instructions](https://github.com/JetBrains/compose-multiplatform-template#setting-up-your-development-environment).
810

911
## How to run
1012

11-
Choose a run configuration for an appropriate target in IDE and run it.
13+
Choose a run configuration for an appropriate target in Android Studio and run it.
1214

1315
![run-configurations.png](run-configurations.png)
1416

15-
To run on iOS device, please correct `TEAM_ID` value in `iosApp/Configuration/Config.xcconfig` with your Apple Team ID.
16-
Alternatively, you may setup signing within XCode opening `iosApp/iosApp.xcworkspace` and then
17-
using "Signing & Capabilities" tab of `iosApp` target.
18-
19-
Then choose **iosApp** configuration in IDE and run it.
20-
2117
## Run on desktop via Gradle
2218

2319
`./gradlew desktopApp:run`
1.68 KB
Loading

‎examples/widgets-gallery/README.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,15 @@ published under [MIT license](third_party/ComposeCookBook_LICENSE.txt).
88
An example of Compose application for Desktop, Android and iOS platforms,
99
demonstrating how to use various Material widgets.
1010

11-
## How to run
11+
## Setting up your development environment
1212

13-
Choose a run configuration for an appropriate target in IDE and run it.
13+
To setup the environment, please consult these [instructions](https://github.com/JetBrains/compose-multiplatform-template#setting-up-your-development-environment).
1414

15-
![run-configurations.png](run-configurations.png)
15+
## How to run
1616

17-
To run on iOS device, please correct `TEAM_ID` value in `iosApp/Configuration/Config.xcconfig` with your Apple Team ID.
18-
Alternatively, you may setup signing within XCode opening `iosApp/iosApp.xcworkspace` and then
19-
using "Signing & Capabilities" tab of `iosApp` target.
17+
Choose a run configuration for an appropriate target in Android Studio and run it.
2018

21-
Then choose **iosApp** configuration in IDE and run it.
19+
![run-configurations.png](run-configurations.png)
2220

2321
## Run on desktop via Gradle
2422

1.68 KB
Loading

0 commit comments

Comments
 (0)
Please sign in to comment.