Updated for v1.1.0j.

Author: seidewitz

dist/README.md

@@ -1,5 +1,5 @@
 # Action Language for UML (Alf) <br> Open Source Reference Implementation
-_Copyright &copy; 2011-2019 Model Driven Solutions, Inc._
+_Copyright &copy; 2011-2020 Model Driven Solutions, Inc._
 
 Alf is an action language for UML developed in response to the OMG <em>Concrete 
 Syntax for a UML Action Language</em> Request for Proposals. The Alf specification 
@@ -27,8 +27,8 @@ The latest version of the implementation is available at http://alf.modeldriven.
 
 ## Licensing
 
-Data Access Technology, Inc. is copyright owner of the source code for this implementation. For licensing terms, see 
-the file [`LICENSING.txt`](https://github.com/ModelDriven/Alf-Reference-Implementation/blob/master/dist/LICENSING.txt).
+Model Driven Solutions, Inc., (formerly Data Access Technology, Inc.) is copyright owner of the source code for this implementation. 
+For licensing terms, see the file [`LICENSING.txt`](https://github.com/ModelDriven/Alf-Reference-Implementation/blob/master/dist/LICENSING.txt).
 
 ## Installation
 
@@ -41,9 +41,14 @@ The installation directory includes Unix (BASH) shell scripts and DOS batch file
 By default, the `Libraries` subdirectory is expected  to be in the same directory as the scripts. 
 If you move it, set the environment variable `ALF_LIB` to its path.
 
+## Further Information
+
+The following sections describe the project structure and build steps for the implementation. For further information on using it, 
+see the [wiki](https://github.com/ModelDriven/Alf-Reference-Implementation/wiki/Home). 
+
 ## Projects
 
-The implementation source is organized into four [Eclipse](http://www.eclipse.org) projects. Eclipse 4.6 or later is required.
+The base implementation source is organized into the following [Eclipse](http://www.eclipse.org) projects. The build is currently tested on Eclipse 2020-06 (4.16).
 
 * `org.modeldriven.alf` - This is the base project, including the
 Alf parser, static semantic checking and generic mapping to fUML.
@@ -64,10 +69,88 @@ metamodel implementation (v5.2.0 or later). It depends on Eclipse plugins and mu
 * `org.modeldriven.alf.eclipse.moka` - This project extends the 
 `org.modeldriven.alf.eclipse` project to allow compiled Alf text to be executed
 using the fUML execution engine from the [Moka framework](http://wiki.eclipse.org/Papyrus/UserGuide/ModelExecution)
-for model execution in the [Eclipse Papyrus](http://www.eclipse.org/papyrus) modeling tool (v3.1.0 or later).
+for model execution in the [Eclipse Papyrus](http://www.eclipse.org/papyrus) modeling tool (specifically v3.1.0).
 It depends on Eclipse plugins and must be built in an Eclipse environment. (Note: This project was called
 `org.modeldriven.alf.eclipse.papyrus` in previous versions of the reference implementation.)
 
-## Further Information
+* `org.modeldriven.alf.tests` - This project provides automated tests.
+
+## Building
+
+### Maven project structure
+
+The project structure under Maven allows building the regular Java modules and the Eclipse-based modules (using [Tycho](https://www.eclipse.org/tycho/)).
+
+#### Master module build
+
+* `./master/pom.xml` - a module that provides standard configurations to be shared by all modules, including the root module.
+
+#### Regular Java build
+
+* `./pom.xml` - the parent module for the regular Java modules
+* `./org.modeldriven.alf` - see [Projects](#Projects) above.
+* `./org.modeldriven.alf.fuml.impl` - see [Projects](#Projects) above.
+* `./org.modeldriven.alf.tests` - see [Projects](#Projects) above.
+* `./org.modeldriven.alf.bundle` - produces a OSGi-bundle from org.modeldriven.alf
+* `./org.modeldriven.alf.fuml.impl.bundle` - produces a OSGi-bundle from org.modeldriven.alf.fuml.impl
+
+#### Tycho build
+
+* `./tycho-pom.xml` - a convenience module that can be used for performing the Tycho (OSGi) aware part of the build. Equivalent to building `./tycho-parent/pom.xml`
+* `./tycho-parent/pom.xml` - the parent module for the Tycho/Eclipse modules
+* `./org.modeldriven.alf.eclipse` - see [Projects](#Projects) above.
+* `./org.modeldriven.alf.eclipse.moka` - see [Projects](#Projects) above.
+
+### Steps
+
+1. Master module build (required only once):
+
+```
+mvn clean install -f master
+```
+
+2. To perform the regular Java build, execute from the root directory:
+
+```
+mvn clean install
+```
+
+3. To perform the Tycho build, execute from the root directory:
+
+```
+mvn clean install -f tycho-pom.xml
+```
+
+## Importing into Eclipse
+
+### Prerequisites
+
+1. Eclipse JDT - Java development tools
+2. Eclipse PDE - Plug-in development environment
+3. Eclipse M2E - Maven Integration in Eclipse
+
+By downloading the Eclipse SDK, you should have all those components.
+
+### Importing as Eclipse projects
+
+That is the simplest way to import the codebase into Eclipse.
+
+1. Import the root directory location using the "Existing Projects into Workspace" option, making sure to select the "Search for nested projects" option.
+2. Configure the [target platform](https://help.eclipse.org/latest/index.jsp?topic=%2Forg.eclipse.pde.doc.user%2Fguide%2Ftools%2Fpreference_pages%2Ftarget_platform.htm) 
+preferences to use the `alf-ri.target` definition you just imported
+3. You may be asked to install M2E extensions to support Tycho projects - this is recommended.
+
+
+### Importing as Maven modules
+
+Alternately, you can import the code as Maven modules, which is recommended to obtain a configuration that is consistent with how the Maven build operates on the codebase.
+
+1. Import the repository root directory and all its children artifacts as "Existing Maven projects" (note that will *not* include the `alf.eclipse` and `alf.eclipse.moka projects`, 
+as they are *not* modules for the base Maven build). 
+**Note:** If you see a build problem with the message "*Duplicate bundle executions found. Please remove any explicitly defined bundle executions in your pom.xml.*", 
+make any non-content change to the POM file and save it, which should make the error go away.
+2. Import the `tycho-parent` directory and all its children artifacts as "Existing Maven projects".
+3. Configure the [target platform](https://help.eclipse.org/latest/index.jsp?topic=%2Forg.eclipse.pde.doc.user%2Fguide%2Ftools%2Fpreference_pages%2Ftarget_platform.htm) preferences 
+to use the `alf-ri.target` definition you just imported
+4. You may be asked to install M2E extensions to support Tycho projects - this is recommended.
 
-For further information on using the implementation, see the [wiki](https://github.com/ModelDriven/Alf-Reference-Implementation/wiki/Home).