From 53861b76f9b0b8d3fc4bf33341877d0a728e59b0 Mon Sep 17 00:00:00 2001 From: Danil Pavlov Date: Tue, 11 Apr 2023 13:30:21 +0200 Subject: [PATCH] update: review suggestions --- README.md | 49 ++++++++++++++++++++++++++----------------------- 1 file changed, 26 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index c584e97..f151f5d 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,21 @@ [![official project](http://jb.gg/badges/official.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) -# Compose Multiplatform mobile application +# [Compose Multiplatform](https://github.com/JetBrains/compose-multiplatform) mobile application > **Note** -> Compose Multiplatform is in Alpha. It may change incompatibly and require manual migration in the future. +> Compose Multiplatform for iOS is in Alpha. It may change incompatibly and require manual migration in the future. > We would appreciate your feedback on it in the public Slack channel [#compose-ios](https://kotlinlang.slack.com/archives/C0346LWVBJ4/p1678888063176359). > If you face any issues, please report them on [GitHub](https://github.com/JetBrains/compose-multiplatform/issues). -You can use this template to start developing your own [Compose Multiplatform](https://github.com/JetBrains/compose-multiplatform) mobile application targeting Android and iOS. -Follow out tutorial below to get your first Compose Multiplatform app up and running. +You can use this template to start developing your own [Compose Multiplatform](https://github.com/JetBrains/compose-multiplatform#readme) mobile application targeting Android and iOS. +Follow our tutorial below to get your first Compose Multiplatform app up and running. The result will be a [Kotlin Multiplatform](https://kotlinlang.org/docs/multiplatform.html) project that uses Compose Multiplatform UI framework. ![](readme_images/banner.png) +If you want to create an application targeting desktop platforms – Windows, macOS, and Linux, +use the [Compose Multiplatform for Desktop template](https://github.com/JetBrains/compose-multiplatform-desktop-template#readme). + ## Set up the environment > **Warning** @@ -137,21 +140,20 @@ To do so, you'll need the following: > **Note** > Before you continue, we suggest creating a simple "Hello, world!" project in Xcode to ensure you can successfully run apps on your device. -> You can follow the instructions below or watch this [this Standford CS193P lecture recording](https://youtu.be/bqu6BquVi2M?start=716&end=1399). -> ->
-> -> How to create and run a simple project in Xcode -> -> 1. On the Xcode welcome screen, select **Create a new project in Xcode**. -> 2. On the **iOS** tab, choose the **App** template. Click **Next**. -> 3. Specify the product name and keep other settings default. Click **Next**. -> 4. Select where to store the project on your computer and click **Create**. You'll see an app that displays "Hello, world!" on the device screen. -> 5. At the top of your Xcode screen, click on a device name near the **Run** button. -> 6. Plug in your device to the computer. You'll see this device in the list of run options. -> 7. Choose your device and click **Run**. -> ->
+> You can follow the instructions below or watch this [Standford CS193P lecture recording](https://youtu.be/bqu6BquVi2M?start=716&end=1399). + +
+How to create and run a simple project in Xcode + +1. On the Xcode welcome screen, select **Create a new project in Xcode**. +2. On the **iOS** tab, choose the **App** template. Click **Next**. +3. Specify the product name and keep other settings default. Click **Next**. +4. Select where to store the project on your computer and click **Create**. You'll see an app that displays "Hello, world!" on the device screen. +5. At the top of your Xcode screen, click on a device name near the **Run** button. +6. Plug in your device to the computer. You'll see this device in the list of run options. +7. Choose your device and click **Run**. + +
##### Finding your Team ID @@ -247,7 +249,7 @@ You can now make some changes in the code and see that they will be visible in b } ``` -3. Re-run both `androidApp` and `iosApp` configurations. You'll see this change reflected on both the Android and iOS apps: +3. Re-run both `androidApp` and `iosApp` configurations. You'll see this change reflected in both the Android and iOS apps: @@ -260,7 +262,7 @@ open the `iosApp/Configuration/Config.xcconfig` file in Android Studio. The conf * `BUNDLE_ID` that [uniquely identifies the app throughout the system](https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleidentifier#discussion) * `TEAM_ID`, [a unique identifier generated by Apple that's assigned to your team](https://developer.apple.com/help/account/manage-your-team/locate-your-team-id/#:~:text=A%20Team%20ID%20is%20a,developer%20in%20App%20Store%20Connect) -To configure the `APP_NAME` option, open `Config.xcconfig` in any text editor *before opening* the project in Android Studio, and set the desired name. +To configure the `APP_NAME` option, open `Config.xcconfig` in any text editor *before opening* the project in Android Studio and set the desired name. If you need to change this option after you open the project in Android Studio, do the following: @@ -274,8 +276,9 @@ go to Xcode and open the `iosApp/iosApp.xcworkspace` file, and make changes. ## Next steps -We encourage you to further explore Compose Multiplatform and try out more projects: +We encourage you to explore Compose Multiplatform further and try out more projects: -* [Learn about other cases where you can use the Compose Multiplatform UI framework](https://github.com/JetBrains/compose-multiplatform) +* [Learn about other cases where you can use the Compose Multiplatform UI framework](https://github.com/JetBrains/compose-multiplatform#readme) +* [Create an application targeting Windows, macOS, and Linux with Compose Multiplatform for Desktop](https://github.com/JetBrains/compose-multiplatform-desktop-template#readme) * [Complete more Compose Multiplatform tutorials](https://github.com/JetBrains/compose-multiplatform#tutorials) * [Explore some more advanced Compose Multiplatform example projects](https://github.com/JetBrains/compose-multiplatform#examples) \ No newline at end of file