[db-jdo] branch master updated: More formatting, and add specification

[an...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

andyj pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/db-jdo.git


The following commit(s) were added to refs/heads/master by this push:
     new 784f08d  More formatting, and add specification
784f08d is described below

commit 784f08d9cdfef30fd6bb8ccd7381e146a87e82f4
Author: Andy Jefferson <an...@datanucleus.org>
AuthorDate: Sat Feb 23 07:25:13 2019 +0000

    More formatting, and add specification
---
 README.md | 28 ++++++++++++----------------
 1 file changed, 12 insertions(+), 16 deletions(-)

diff --git a/README.md b/README.md
index 8de7895..abc60e2 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,7 @@ The Apache JDO project includes the following subprojects:
 * [exectck](https://github.com/apache/db-jdo/tree/master/exectck) contains source to build the maven plugin to run the TCK the Reference Implementation (RI) or an implementation under test (IUT)
 * [tck](https://github.com/apache/db-jdo/tree/master/tck) contains the JDO Technology Compatibility Kit for Java 1.8 and later.
 * [parent-pom](https://github.com/apache/db-jdo/tree/master/parent-pom) contains the Maven `pom.xml` that ties the projects together.
+* [specification](https://github.com/apache/db-jdo/tree/master/specification) contains the JDO API specification, in OpenDocument format.
 
 JDO releases may be downloaded from [the Apache JDO downloads page](http://db.apache.org/jdo/downloads.html).
 Minor updates of releases are only available as source from the GitHub repository.
@@ -17,31 +18,27 @@ For complete rules for certifying a JDO implementation, see [RunRules.html](http
 ## Prerequisites
 
 You must install the software listed in the following sections to successfully run the TCK.
-Other dependencies, such as the reference implementation, DataNucleus, and the Apache Derby database, are downloaded automatically by Maven.
+Other dependencies, such as the reference implementation, [DataNucleus](https://github.com/datanucleus), and the Apache Derby database, are downloaded automatically by Maven.
 Note that Apache JDO uses the Apache Commons Logging package for logging.
 
 ### Maven
 
 You must have Maven (version 2+) to build the projects from source and to execute the TCK. You can download Maven from [here](http://maven.apache.org/download.html)
 
-Note that Maven uses the `user.home` system property for the location of the maven local repostitory: `${user.home}/.m2/repository`.
-Under Windows this system property is `C:\Documents and Settings\{user}` no matter what the HOME variable is set to. As a workaround you may set the system property by adding `-Duser.home=%HOME%` to the environment variable `MAVEN_OPTS`.
+Note that Maven uses the `user.home` system property for the location of the Maven local repostitory: `${user.home}/.m2/repository`.
+Under Windows this system property is `C:\Documents and Settings\{user}` no matter what the `HOME` variable is set to. As a workaround you may set the system property by adding `-Duser.home=%HOME%` to the environment variable `MAVEN_OPTS`.
 
 ### JNDI Implementation (fscontext.jar and providerutil.jar)
 
-The JNDI test cases in tck need a JNDI implementation.
-The TCK is configured to use Sun's JNDI implementation.
-To use your own implementation, put the implementation
-jar files into <i>lib/ext</i> and update `jndi.properties` in the TCK directory src/conf.  
-To download Oracle's implementation, go [here](http://www.oracle.com/technetwork/java/javasebusiness/downloads/java-archive-downloads-java-plat-419418.html#7110-jndi-1.2.1-oth-JPR).
-Accept the license agreement and download *File System Service Provider, 1.2 Beta 3* and then unpack the downloaded zip into `lib/ext`. It includes the jars `fscontext.jar` and `providerutil.jar`.
+The JNDI test cases in tck need a JNDI implementation. The TCK is configured to use Sun's JNDI implementation. To use your own implementation, put the implementation jar files into `lib/ext` and update `jndi.properties` in the TCK directory `src/conf`.  
+To download Oracle's implementation, go [here](http://www.oracle.com/technetwork/java/javasebusiness/downloads/java-archive-downloads-java-plat-419418.html#7110-jndi-1.2.1-oth-JPR). Accept the license agreement and download *File System Service Provider, 1.2 Beta 3* and then unpack the downloaded zip into `lib/ext`. It includes the jars `fscontext.jar` and `providerutil.jar`.
 
 
 ## Building from Top Level TCK Project
 
 For instructions for checking out the JDO source, see the Apache JDO [source code](http://db.apache.org/jdo/svn.html) page.
 
-To build JDO with all subprojects go to the root directory of the branch you are working in (or trunk)
+To build JDO with all subprojects go to the root directory of the branch you are working in (or master)
 
     mvn clean install
 
@@ -50,7 +47,7 @@ This will build the artifacts *jdo-api* and *jdo-exectck* and will run the TCK.
 
 ## Building the JDO API
 
-To build the API, change to the "api" directory of the branch you are working in (or trunk) and run
+To build the API, change to the "api" directory of the branch you are working in (or master) and run
 
     mvn clean install
 
@@ -59,18 +56,17 @@ This will build the *jdo-api* artifact and install it in your local Maven reposi
 
 ## Running the JDO TCK on an Implementation Under Test
 
-First build the from the top level TCK project as described above.
+Firstly build from the top level TCK project as described above.
 To run the JDO TCK on an Implementation Under Test, edit [tck/pom.xml](https://github.com/apache/db-jdo/blob/master/tck/pom.xml) and add the iut dependencies to the profile called *iut*. 
-Also check the following files under [tck/src/main/resources/conf](https://github.com/apache/db-jdo/tree/master/tck/src/main/resources/conf) and change the content to the needs of the Implementation Under Test:
-`iut-jdoconfig.xml`, `iut-log4j.properties`, `iut-persistence.xml` and `iut-pmf.properties`.
+Also check the following files under [tck/src/main/resources/conf](https://github.com/apache/db-jdo/tree/master/tck/src/main/resources/conf) and change the content to the needs of the Implementation Under Test: `iut-jdoconfig.xml`, `iut-log4j.properties`, `iut-persistence.xml` and `iut-pmf.properties`.
 
-Change to the "tck" directory of the branch you are working in (or trunk) and run
+Change to the "tck" directory of the branch you are working in (or master) and run
 
     mvn -Djdo.tck.impl="iut" clean install
 
 and this will run the TCK (via the "jdo-exectck" plugin) on the Implementation Under Test on all supported databases and identity types.
 
-The "jdo-exectck" plugin has various options so you can run other implementations or only run particular tests.
+The *jdo-exectck* Maven plugin (built from the *exectck* directory) has various options so you can run other implementations or only run particular tests.
 
 
 ### Custom Goals