Skip to content

Commit fa4e6df

Browse files
committed
readme
1 parent 5d07f99 commit fa4e6df

File tree

1 file changed

+12
-59
lines changed

1 file changed

+12
-59
lines changed

README.md

+12-59
Original file line numberDiff line numberDiff line change
@@ -8,70 +8,23 @@
88
This repo is a template for getting started with Compose Multiplatform or Kotlin Multiplatform with support for Android, iOS, and Desktop.
99

1010
**Compose Multiplatform** sample:
11-
- https://github.com/hoc081098/kmp-viewmodel: Multiplatform ViewModel, SavedStateHandle
12-
- https://github.com/hoc081098/solivagant: Compose Multiplatform Navigation
13-
- https://github.com/JetBrains/compose-multiplatform
11+
- https://github.com/hoc081098/kmp-viewmodel: Multiplatform ViewModel, SavedStateHandle
12+
- https://github.com/hoc081098/solivagant: Compose Multiplatform Navigation
13+
- https://github.com/JetBrains/compose-multiplatform
1414

1515
Liked some of my work? Buy me a coffee (or more likely a beer)
1616

1717
<a href="https://www.buymeacoffee.com/hoc081098" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-blue.png" alt="Buy Me A Coffee" height=64></a>
1818

1919
### Modern Development
20-
- Kotlin Multiplatform
21-
- [JetBrains Compose Multiplatform](https://github.com/JetBrains/compose-multiplatform)
22-
- [Kotlin Coroutines & Flows](https://github.com/hoc081098/FlowExt)
23-
- Koin Dependency Injection
24-
- Model-View-Intent (MVI) / FlowRedux state management
25-
- [Kotlin Multiplatform ViewModel](https://github.com/hoc081098/kmp-viewmodel)
26-
- Clean Architecture
27-
- Compose Multiplatform type-safe navigation by [solivagant](https://github.com/hoc081098/solivagant)
2820

29-
https://user-images.githubusercontent.com/36917223/270357793-11cb7264-59fe-4f58-884a-c92c204b566f.mov
30-
31-
### Set up the environment
32-
33-
> **Warning**
34-
> You need a Mac with macOS to write and run iOS-specific code on simulated or real devices.
35-
> This is an Apple requirement.
36-
37-
To work with this template, you need the following:
38-
39-
* A machine running a recent version of macOS
40-
* [Xcode](https://apps.apple.com/us/app/xcode/id497799835)
41-
* [Android Studio](https://developer.android.com/studio)
42-
* The [Kotlin Multiplatform Mobile plugin](https://plugins.jetbrains.com/plugin/14936-kotlin-multiplatform-mobile)
43-
* The [CocoaPods dependency manager](https://kotlinlang.org/docs/native-cocoapods.html)
44-
45-
#### Check your environment
46-
47-
Before you start, use the [KDoctor](https://github.com/Kotlin/kdoctor) tool to ensure that your development environment
48-
is configured correctly:
49-
50-
1. Install KDoctor with [Homebrew](https://brew.sh/):
21+
- Kotlin Multiplatform
22+
- [JetBrains Compose Multiplatform](https://github.com/JetBrains/compose-multiplatform)
23+
- [Kotlin Coroutines & Flows](https://github.com/hoc081098/FlowExt)
24+
- Koin Dependency Injection
25+
- Model-View-Intent (MVI) / FlowRedux state management
26+
- [Kotlin Multiplatform ViewModel](https://github.com/hoc081098/kmp-viewmodel)
27+
- Clean Architecture
28+
- Compose Multiplatform type-safe navigation by [solivagant](https://github.com/hoc081098/solivagant)
5129

52-
```text
53-
brew install kdoctor
54-
```
55-
56-
2. Run KDoctor in your terminal:
57-
58-
```text
59-
kdoctor
60-
```
61-
62-
If everything is set up correctly, you'll see valid output:
63-
64-
```text
65-
Environment diagnose (to see all details, use -v option):
66-
[✓] Operation System
67-
[✓] Java
68-
[✓] Android Studio
69-
[✓] Xcode
70-
[✓] Cocoapods
71-
72-
Conclusion:
73-
✓ Your system is ready for Kotlin Multiplatform Mobile development!
74-
```
75-
76-
Otherwise, KDoctor will highlight which parts of your setup still need to be configured and will suggest a way to fix
77-
them.
30+
https://user-images.githubusercontent.com/36917223/270357793-11cb7264-59fe-4f58-884a-c92c204b566f.mov

0 commit comments

Comments
 (0)