@@ -28,43 +28,36 @@ This file is useful for understanding the role of each subproject in the reposit
2828To work with this repository, the Android SDK must be installed. Use the ` sdkmanager ` command-line
2929tool for this purpose.
3030
31- 1 . ** Install Android SDK Command-Line Tools** :
32-
33- - If not already installed, download the command-line tools from the
34- [ Android Studio page] ( https://developer.android.com/studio#command-line-tools-only ) .
35- - Create a directory for the Android SDK, e.g., ` android_sdk ` .
36- - Unzip the downloaded package. This will create a ` cmdline-tools ` directory. Move this
37- directory to ` android_sdk/cmdline-tools/latest ` .
38- - The final structure should be ` android_sdk/cmdline-tools/latest/ ` .
39-
40- 2 . ** Install required SDK packages** :
41-
42- - Use ` sdkmanager ` to install the necessary platforms, build tools, and other packages. For
43- example:
44-
45- ``` bash
46- # List all available packages
47- sdkmanager --list
48-
49- # Install platform tools and the SDK for API level 33
50- sdkmanager " platform-tools" " platforms;android-33"
51-
52- # Accept all licenses
53- yes | sdkmanager --licenses
54- ```
55-
56- - Refer to the specific requirements of the project to determine which packages to install.
57-
58- 3. ** Configure for integration tests** :
59-
60- - To run integration tests, a ` google-services.json` file is required.
61- - Place this file in the root of the repository.
62-
63- 4. ** Install NDK for specific projects** :
64- - Some projects, like ` firebase-crashlytics-ndk` , require a specific version of the Android NDK.
65- You can install it using ` sdkmanager` . For example, to install NDK version 21.4.7075529, you
66- would run ` sdkmanager " ndk;21.4.7075529" ` . Always refer to the project' s `README.md` for the
67- exact version required.
31+ 1 . ** Install Android SDK Command-Line Tools** :
32+ - If not already installed, download the command-line tools from the
33+ [ Android Studio page] ( https://developer.android.com/studio#command-line-tools-only ) .
34+ - Create a directory for the Android SDK, e.g., ` android_sdk ` .
35+ - Unzip the downloaded package. This will create a ` cmdline-tools ` directory. Move this
36+ directory to ` android_sdk/cmdline-tools/latest ` .
37+ - The final structure should be ` android_sdk/cmdline-tools/latest/ ` .
38+ 2 . ** Install required SDK packages** :
39+ - Use ` sdkmanager ` to install the necessary platforms, build tools, and other packages. For
40+ example:
41+
42+ ``` bash
43+ # List all available packages
44+ sdkmanager --list
45+
46+ # Install platform tools and the SDK for API level 33
47+ sdkmanager " platform-tools" " platforms;android-33"
48+
49+ # Accept all licenses
50+ yes | sdkmanager --licenses
51+ ```
52+ - Refer to the specific requirements of the project to determine which packages to install.
53+ 3. ** Configure for integration tests** :
54+ - To run integration tests, a ` google-services.json` file is required.
55+ - Place this file in the root of the repository.
56+ 4. ** Install NDK for specific projects** :
57+ - Some projects, like ` firebase-crashlytics-ndk` , require a specific version of the Android NDK.
58+ You can install it using ` sdkmanager` . For example, to install NDK version 21.4.7075529, you
59+ would run ` sdkmanager " ndk;21.4.7075529" ` . Always refer to the project' s `README.md` for the
60+ exact version required.
6861
6962## Building and Running
7063
@@ -182,10 +175,12 @@ started.
182175After you make a change, here' s the flow you should follow:
183176
184177- Format the code using ` spotless` . It can be run with:
178+
185179 ` ` ` bash
186180 ./gradlew :< firebase-project> :spotlessApply
187181 ` ` `
188182- Run unit tests:
183+
189184 ` ` ` bash
190185 ./gradlew :< firebase-project> :check
191186 ` ` `
0 commit comments