From 9a06c2c00dc532c97332bf800e29d95cb862f369 Mon Sep 17 00:00:00 2001 From: nmittler Date: Tue, 20 Dec 2016 15:35:00 -0800 Subject: [PATCH] Fixing some text in README.md --- README.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 582578a9c..b66717c97 100644 --- a/README.md +++ b/README.md @@ -27,8 +27,8 @@ similar performance. Download ------------- -NOTE: This section is under construction! Artifacts have -not yet been published to the public Maven repositories. +NOTE: This section is under construction! Artifacts have +not yet been published to the public Maven repositories. #### Download JARs You can download @@ -98,17 +98,13 @@ instructions](BUILDING.md). Source Overview ---------------------------- -Here's a quick readers' guide to the code to help folks get started. At a high -level there are three distinct modules: __Common__, __Android__ & -__OpenJDK__. +Here's a quick readers' guide to the code to help folks get started. The high-level modules are __Common__, __Android__, +__OpenJDK__, and __Platform__. ### Common -This contains the bulk of the code. It contains stub classes for platform-specific functions, which -are stripped out of the final JAR. - -It also contains all of the native code, but does not build any native artifacts. Instead, the -platform-specific modules will include this source in their builds. +This contains the bulk of the code for both Java and C. This isn't an actual module and builds no +artifacts. Rather, the other modules just point to this directory as source. ### Android @@ -119,3 +115,8 @@ supporting various versions of Android. This generates an `apk` library artifact This modules provides the `Platform` class for non-Android (OpenJDK-based) systems. It also provides a native library loader supports bundling the shared library with the JAR. + +### Platform + +This is not an actual module and is not part of the default build. This is used for building + Conscrypt as an embedded component of the Android platform. \ No newline at end of file