summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
author Lukacs T. Berki <lberki@google.com> 2022-10-10 07:06:35 +0000
committer Lukacs T. Berki <lberki@google.com> 2022-10-12 12:22:38 +0000
commit84f8b98843377992f0840bbd731ae3691875c14e (patch)
treeedd7c25b3d10b8e103f6aeb69f22dd41cff31ae7 /README.md
parent8e4a787ae735ea9bfc0374ad2af7e3d50156ea44 (diff)
Add a "Contributing" section to README.md .
Test: documentation change. Change-Id: Icb87fbb73abe28e1760bd452c26bda058aa5d22c
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 23 insertions, 3 deletions
diff --git a/README.md b/README.md
index 87d6948da..18cf7b2ad 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,33 @@
# Soong
-Soong is the replacement for the old Android make-based build system. It
-replaces Android.mk files with Android.bp files, which are JSON-like simple
-declarative descriptions of modules to build.
+Soong is one of the build systems used in Android. There are altogether three:
+* The legacy Make-based build system that is controlled by files called
+ `Android.mk`.
+* Soong, which is controlled by files called `Android.bp`.
+* The upcoming Bazel-based build system that is controlled by files called
+ `BUILD.bazel`.
+
+`Android.bp` file are JSON-like declarative descriptions of "modules" to build;
+a "module" is the basic unit of building that Soong understands, similarly to
+how "target" is the basic unit of building for Bazel (and Make, although the
+two kinds of "targets" are very different)
See [Simple Build
Configuration](https://source.android.com/compatibility/tests/development/blueprints)
on source.android.com to read how Soong is configured for testing.
+### Contributing
+
+Code reviews are handled through the usual code review system of Android,
+available [here](https://android-review.googlesource.com/dashboard/self).
+
+For simple changes (fixing typos, obvious optimizations, etc.), sending a code
+review request is enough. For more substantial changes, file a bug in our
+[bug tracker](https://issuetracker.google.com/issues/new?component=381517) or
+or write us at android-building@googlegroups.com .
+
+For Googlers, see our [internal documentation](http://go/soong).
+
## Android.bp file format
By design, Android.bp files are very simple. There are no conditionals or