material-components_materia.../docs/building-from-source.md
Subhrajyoti Sen 5084a62db9 Add note to not update Gradle to beyond 4.10
The dependency on android-maven-gradle-plugin does not compile on Gradle 5.x.
Refer: https://github.com/dcendents/android-maven-gradle-plugin/blob/develop/README.md

Resolves https://github.com/material-components/material-components-android/pull/395

GIT_ORIGIN_REV_ID=eed4df09dddae4dcae21bbe11cc47361e3937e5c
PiperOrigin-RevId: 254229290
2019-06-24 17:03:08 -04:00

52 lines
1.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!--docs:
title: "Building From Source"
layout: landing
section: docs
path: /docs/building-from-source/
-->
# Building From the Latest Source
If you'll be contributing to the library, or need a version newer than what has
been released, Material Components for Android can also be built from source.
To do so:
Clone the repository:
```sh
git clone https://github.com/material-components/material-components-android.git
```
Then, build the library's AARs using Gradle:
```sh
./gradlew uploadArchives -PmavenRepoUrl="file://localhost/<path_to_aars>"
```
This will output AARs and Maven artifacts for each of the library's modules
to the path on your machine, e.g., `$HOME/Desktop/material_aars`.
To use the AARs in your app locally, copy the output from your AAR directory
into your local Maven repository (`~/.m2/repository`). Then add `mavenLocal()`
as a repository in your project's top-level `build.gradle` file. Finally, add
the Design Library dependency as you would normally, using the version
specified as `mdcLibraryVersion` in the library's top-level `build.gradle`
file.
Note: Do not update Gradle beyond 4.10 as the
[android-maven-gradle-plugin](https://github.com/dcendents/android-maven-gradle-plugin)
dependency cannot be used for Gradle 5.x.
## Useful Links
- [Getting Started](getting-started.md)
- [Contributing](contributing.md)
- [Catalog App](catalog-app.md)
- [Class
documentation](https://developer.android.com/reference/com/google/android/material/classes)
- [MDC-Android on Stack
Overflow](https://www.stackoverflow.com/questions/tagged/material-components+android)
- [Android Developers
Guide](https://developer.android.com/training/material/index.html)
- [Material.io](https://www.material.io)
- [Material Design Guidelines](https://material.google.com)