Skip to content

Commit 5b6cf55

Browse files
dsn5ftleticiarossi
authored andcommitted
[Docs] Update Getting Started instructions with latest requirements and info
PiperOrigin-RevId: 629732598
1 parent cadbd6a commit 5b6cf55

File tree

1 file changed

+33
-36
lines changed

1 file changed

+33
-36
lines changed

docs/getting-started.md

Lines changed: 33 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -71,21 +71,17 @@ the `com.android.support:design:28.0.0` dependency.
7171
**Note:** You should not use the `com.android.support` and
7272
`com.google.android.material` dependencies in your app at the same time.
7373
74-
## 3. Android 12 compilation
74+
## 3. Android SDK compilation
7575
7676
In order to use the latest versions of Material Components for Android and the
7777
AndroidX Jetpack libraries, you will have to install the latest version of
78-
Android Studio and update your app's `compileSdkVersion` to `32`.
79-
80-
As part of migrating to Android 12, you'll need to add `android:exported` to any
81-
activities, services, or broadcast receivers in your manifest that use intent
82-
filters (see the
83-
[documentation](https://developer.android.com/about/versions/12/behavior-changes-12#exported)).
84-
Consider reading through the Android 12
85-
[app migration guide](https://developer.android.com/about/versions/12/migration)
86-
and
87-
[behavior changes](https://developer.android.com/about/versions/12/behavior-changes-all)
88-
for more tips and information.
78+
Android Studio and update your app to meet the following requirements:
79+
80+
- `compileSdkVersion` -> `34` or later (see the
81+
[Android 14 app migration guide](https://developer.android.com/about/versions/14/migration))
82+
- `minSdkVersion` -> `19` or later (see this
83+
[AndroidX blog post](https://android-developers.googleblog.com/2023/10/androidx-minsdkversion-19.html)
84+
for more info)
8985
9086
## 4. Java 8 compilation
9187
@@ -96,13 +92,13 @@ for more information on Java 8 support and how to enable it for your app.
9692
9793
## 5. Gradle, AGP, and Android Studio
9894
99-
When using MDC-Android version `1.7.0-alpha02` and above, you will need to make
100-
sure your project is built with the following minimum requirements, in order to
95+
When using MDC-Android version `1.7.0` and above, you will need to make sure
96+
your project is built with the following minimum requirements, in order to
10197
support the latest build features such as XML `macro`:
10298
103-
- [Gradle version 7.3.3](https://developer.android.com/studio/releases/gradle-plugin#updating-gradle)
104-
- [Android Gradle Plugin (AGP) version 7.2.0](https://developer.android.com/studio/releases/gradle-plugin#updating-gradle)
105-
- [Android Studio Chipmunk, version 2021.2.1](https://developer.android.com/studio/releases/gradle-plugin#android_gradle_plugin_and_android_studio_compatibility)
99+
- [Gradle version 7.3.3](https://developer.android.com/studio/releases/gradle-plugin#updating-gradle)
100+
- [Android Gradle Plugin (AGP) version 7.2.0](https://developer.android.com/studio/releases/gradle-plugin#updating-gradle)
101+
- [Android Studio Chipmunk, version 2021.2.1](https://developer.android.com/studio/releases/gradle-plugin#android_gradle_plugin_and_android_studio_compatibility)
106102
107103
## 6. `AppCompatActivity`
108104
@@ -137,22 +133,22 @@ Here are the `Material3` themes you can use to get the latest component styles
137133
and theme-level attributes, as well as their `MaterialComponents` equivalents
138134
when applicable.
139135
140-
| `Material3` | `MaterialComponents` |
141-
|------------------------------------------------------|---------------------------------------------------|
142-
| `Theme.Material3.Light` | `Theme.MaterialComponents.Light` |
143-
| `Theme.Material3.Light.NoActionBar` | `Theme.MaterialComponents.Light.NoActionBar` |
144-
| `Theme.Material3.Dark` | `Theme.MaterialComponents` |
145-
| `Theme.Material3.Dark.NoActionBar` | `Theme.MaterialComponents.NoActionBar` |
146-
| `Theme.Material3.DayNight` | `Theme.MaterialComponents.DayNight` |
147-
| `Theme.Material3.DayNight.NoActionBar` | `Theme.MaterialComponents.DayNight.NoActionBar` |
148-
| `Theme.Material3.DynamicColors.Light` | N/A |
149-
| `Theme.Material3.DynamicColors.Light.NoActionBar` | N/A |
150-
| `Theme.Material3.DynamicColors.Dark` | N/A |
151-
| `Theme.Material3.DynamicColors.Dark.NoActionBar` | N/A |
152-
| `Theme.Material3.DynamicColors.DayNight` | N/A |
153-
| `Theme.Material3.DynamicColors.DayNight.NoActionBar` | N/A |
154-
| N/A | `Theme.MaterialComponents.Light.DarkActionBar` |
155-
| N/A | `Theme.MaterialComponents.DayNight.DarkActionBar` |
136+
`Material3` | `MaterialComponents`
137+
---------------------------------------------------- | --------------------
138+
`Theme.Material3.Light` | `Theme.MaterialComponents.Light`
139+
`Theme.Material3.Light.NoActionBar` | `Theme.MaterialComponents.Light.NoActionBar`
140+
`Theme.Material3.Dark` | `Theme.MaterialComponents`
141+
`Theme.Material3.Dark.NoActionBar` | `Theme.MaterialComponents.NoActionBar`
142+
`Theme.Material3.DayNight` | `Theme.MaterialComponents.DayNight`
143+
`Theme.Material3.DayNight.NoActionBar` | `Theme.MaterialComponents.DayNight.NoActionBar`
144+
`Theme.Material3.DynamicColors.Light` | N/A
145+
`Theme.Material3.DynamicColors.Light.NoActionBar` | N/A
146+
`Theme.Material3.DynamicColors.Dark` | N/A
147+
`Theme.Material3.DynamicColors.Dark.NoActionBar` | N/A
148+
`Theme.Material3.DynamicColors.DayNight` | N/A
149+
`Theme.Material3.DynamicColors.DayNight.NoActionBar` | N/A
150+
N/A | `Theme.MaterialComponents.Light.DarkActionBar`
151+
N/A | `Theme.MaterialComponents.DayNight.DarkActionBar`
156152
157153
Update your app theme to inherit from one of these themes:
158154
@@ -261,9 +257,10 @@ theme, or you will encounter `ThemeEnforcement` errors:
261257

262258
## 8. Add Material components
263259

264-
Take a look at our [documentation](https://material.io/components?platform=android)
265-
for the full list of available Material components. Each component's page has
266-
specific instructions on how to implement it in your app.
260+
Take a look at our
261+
[documentation](https://material.io/components?platform=android) for the full
262+
list of available Material components. Each component's page has specific
263+
instructions on how to implement it in your app.
267264

268265
Let's use [text fields](components/TextField.md) as an example.
269266

0 commit comments

Comments
 (0)