Commit 04842ece authored by MozLando's avatar MozLando
Browse files

Merge #4634



4634: Add more descriptive instructions to README.md [ci skip] r=Amejia481 a=espertus
Co-authored-by: default avatarEllen Spertus <ellen.spertus@gmail.com>
parents 35c1f766 2e266a9d
......@@ -30,7 +30,7 @@ Before you attempt to make a contribution please read the [Community Participati
# Maven repository
All components are getting published on [maven.mozilla.org](https://maven.mozilla.org/).
To use them, you need to add the following to your projects top-level build file, in the `allprojects` block (see e.g. the [reference-browser](https://github.com/mozilla-mobile/reference-browser/blob/master/build.gradle)):
To use them, you need to add the following to your project's top-level build file, in the `allprojects` block (see e.g. the [reference-browser](https://github.com/mozilla-mobile/reference-browser/blob/master/build.gradle)):
```groovy
repositories {
......@@ -40,6 +40,14 @@ repositories {
}
```
Each module that uses a component needs to specify it in its build file, in the `dependencies` block. For example, to use the `Base` component (in the `support`) collection, you need:
```groovy
dependencies {
implementation 'org.mozilla.components:support-base:+'
}
```
## Snapshot builds
Snapshots are build daily from the `master` branch and published on [snapshots.maven.mozilla.org](https://snapshots.maven.mozilla.org).
......@@ -274,6 +282,15 @@ If the environment variable `JAVA_HOME` is not defined, you will need to set it.
Once the environment variable is set, you can import the project into Android Studio with the default wizard options.
## Style ##
We follow the style enforced by [ktlint](https://ktlint.github.io/). See [how to configure Android Studio appropriately](https://github.com/pinterest/ktlint#option-1-recommended).
To check your style, run:
```
./gradlew ktlint
```
# License
This Source Code Form is subject to the terms of the Mozilla Public
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment