Further README updates
Test: n/a
Change-Id: I5d8837f1533ed322369735d93b30284916e64a06
diff --git a/README.md b/README.md
index 968cbda..9acde2d 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# AOSP AndroidX Contribution Guide
## Accepted Types of Contributions
-* Bug fixes (needs a corresponding bug report in b.android.com)
+* Bug fixes - needs a corresponding bug report in the [Android Issue Tracker](https://issuetracker.google.com/issues/new?component=192731&template=842428)
* Each bug fix is expected to come with tests
* Fixing spelling errors
* Updating documentation
@@ -16,7 +16,7 @@
repo init -u https://android.googlesource.com/platform/manifest -b androidx-master-dev
-Now your repository is set to pull only what you need for building and running Androix libraries. Download the code (and grab a coffee while we pull down 3GB):
+Now your repository is set to pull only what you need for building and running AndroidX libraries. Download the code (and grab a coffee while we pull down 3GB):
repo sync -j8 -c
@@ -37,11 +37,14 @@
cd path/to/checkout/frameworks/support/
./gradlew createArchive
-### Building AndroidX Libraries as part of your App build
-If you intend to repeatedly make changes to AndroidX Libraries and to wish to see
-the results in your app, and you don't want to have to repeatedly build them as
-separate Gradle projects, you can
-[configure your app build to build AndroidX Libraries too](adding-support-library-as-included-build.md)
+### Testing modified AndroidX Libraries to in your App
+You can build maven artifacts locally, and test them directly in your app:
+
+ ./gradlew createArchive
+
+And put in your **project** `build.gradle` file:
+
+ handler.maven { url '/path/to/checkout/out/host/gradle/frameworks/support/build/support_repo' }
## Running Tests
@@ -55,9 +58,9 @@
3. Right-click on the directory and select `Run androidx.foobar`
## Running Sample Apps
-AndroidX libraries has a set of Android applications that exercise AndroidX code. These applications can be useful when you want to debug a real running application, or reproduce a problem interactively, before writing test code.
+The AndroidX repository has a set of Android applications that exercise AndroidX code. These applications can be useful when you want to debug a real running application, or reproduce a problem interactively, before writing test code.
-These applications are named support-\*-demos (e.g. support-4v-demos or support-leanback-demos. You can run them by clicking `Run > Run ...` and choosing the desired application.
+These applications are named either `<libraryname>-integration-tests-testapp`, or `support-\*-demos` (e.g. `support-4v-demos` or `support-leanback-demos`). You can run them by clicking `Run > Run ...` and choosing the desired application.
## Making a change
cd path/to/checkout/frameworks/support/
@@ -70,6 +73,15 @@
Run hook scripts from https://android.googlesource.com/platform/manifest (yes/always/NO)?
+If the upload succeeds, you'll see output like:
+
+ remote:
+ remote: New Changes:
+ remote: https://android-review.googlesource.com/c/platform/frameworks/support/+/720062 Further README updates
+ remote:
+
+To edit your change, use `git commit --amend`, and re-upload.
+
## Getting reviewed
* After you run repo upload, open [r.android.com](http://r.android.com)
* Sign in into your account (or create one if you do not have one yet)
diff --git a/adding-support-library-as-included-build.md b/adding-support-library-as-included-build.md
deleted file mode 100644
index b77233e..0000000
--- a/adding-support-library-as-included-build.md
+++ /dev/null
@@ -1,35 +0,0 @@
-# Adding the Support Library Build Within Another Build
-
-Sorry, this doesn't seem to be working at the moment.
-For now, run `./gradlew createArchive` and copy the output to where your project can use it, as described fuller in go/support-dev
-
-Would you like to make a change in Support Library and have it be propagated to
-your downstream Gradle build (generally an app) without having to separately
-build Support Library and then build your application?
-
-## To build Support Library as part of your existing Gradle build
-* To add the Support Library build
- * Add `apply(from: '<support-lib-repo-root>/frameworks/support/include-support-library.gradle')`
- to your settings.gradle
- * See [include-support-library.gradle](include-support-library.gradle)
- for more information
-* If your project is an Android app, also update some dependencies:
- * Open your local.properties file and update the value of `sdk.dir` .
- * It should point to `<support-lib-repo-root>/prebuilts/fullsdk-<platform>` .
- * For example, `~/support-library/prebuilts/fullsdk-linux` .
- * In your build.gradle, update any versions that refer to previous versions of
- Support Library.
- * To determine the correct version, find the SDK with the highest
- number among SDKs in the Support Library repo.
-
- echo <support-lib-repo-root>/prebuilts/fullsdk-linux/platforms/android* | xargs -n 1 echo | sed 's/.*android-//' | tail -n 1
-
- This should output, for example, "28"
-
- * Update dependency versions
- * For example, you may want to replace
- `com.android.support:app-compat-v7:26.0.2` with
- `com.android.support:app-compat-v7:28.0.2`
- * Update configuration given to the Android Gradle plugin
- * Check `compileSdkVersion` and make sure its version is correct
-
