Skip to content

Commit 0de4da6

Browse files
seidewitzseidewitz
committed
Replaced org.modeldriven.fuml/ReadMe.txt with README.md.
1 parent c577f70 commit 0de4da6

2 files changed

Lines changed: 44 additions & 48 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,14 +110,14 @@ drive's root directory. The deployment directory will be called:
110110
DEPLOYED implementation. The implementation can only be run from a DEPLOYED
111111
binary or source distribution (see above).
112112

113-
2. To load a UML model file (XMI 2.1 or 2.4.1 format) and execute one or more behaviors
113+
2. To load a UML model file (XMI 2.1 or 2.4.1/2.5 format) and execute one or more behaviors
114114
(activities), use the following command:
115115

116116
fuml <model-file> [<behavior-name> <behavior-name> <behavior-name> <...>]
117117

118118
Where:
119119

120-
* `<model-file>` is UML model file (XMI 2.1 or 2.4.1 format)
120+
* `<model-file>` is UML model file (XMI 2.1 or 2.4.1/2.5 format)
121121

122122
* `<behavior-name>` is a named behavior within the model-file
123123

org.modeldriven.fuml/ReadMe.txt renamed to org.modeldriven.fuml/README.md

Lines changed: 42 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -13,31 +13,29 @@ Corporation funded project with Model Driven Solutions (a division of Data
1313
Access Technologies) in 2008. The objectives for making this reference
1414
implementation open source are to:
1515

16-
a) encourage tool vendors to implement this standard in their tools
16+
1. encourage tool vendors to implement this standard in their tools
1717

18-
b) provide a reference that can assist in evaluating vendor implementations
18+
2. provide a reference that can assist in evaluating vendor implementations
1919
conformance with the specification
2020

21-
c) encourage evolution of the reference implementation to support further
21+
3. encourage evolution of the reference implementation to support further
2222
enhancements to its functionality such as a model debugger, or animation of the
2323
execution trace
2424

25-
d) support evaluation and evolution of the the specification to support UML
25+
4. support evaluation and evolution of the the specification to support UML
2626
execution semantics and the execution semantics of its profiles suchas SysML.
2727

28-
Licensing
29-
---------
28+
###Licensing
3029

31-
For licensing information, please see the file Licensing-Information.txt and the
32-
associated files Common-Public-License-1.0.txt and Apache-License-2.0.txt.
30+
For licensing information, please see the file [Licensing-Information.txt](https://github.com/ModelDriven/fUML-Reference-Implementation/blob/master/org.modeldriven.fuml/Licensing-Information.txt) and the
31+
associated files [Common-Public-License-1.0.txt](https://github.com/ModelDriven/fUML-Reference-Implementation/blob/master/org.modeldriven.fuml/Common-Public-License-1.0.txt) and [Apache-License-2.0.txt](https://github.com/ModelDriven/fUML-Reference-Implementation/blob/master/org.modeldriven.fuml/Apache-License-2.0.txt).
3332

34-
Building
35-
--------
33+
###Building
3634

3735
The implementation build requires the following to be installed:
3836

39-
Oracle Java Version 6 or above - see http://java.oracle.com/
40-
Apache Maven Version 2.2 or above - see http://maven.apache.org/
37+
* Oracle Java Version 6 or above - see http://java.oracle.com/
38+
* Apache Maven Version 2.2 or above - see http://maven.apache.org/
4139

4240
To build from the command line:
4341

@@ -46,8 +44,8 @@ implementation directory.
4644
This directory is where the Apache Maven 'pom.xml' file can be found.
4745

4846
2. Use the following command:
49-
50-
mvn -DskipTests install
47+
48+
mvn -DskipTests install
5149

5250
Several targets will be executed, and the message 'BUILD SUCCESSFUL' should
5351
be displayed. Generated and compiled code can be found under the 'target'
@@ -56,31 +54,30 @@ directory.
5654
To build using Eclipse:
5755
The implementation build requires Eclipse Kepler or above with the M2E plugin and dependencies:
5856

59-
1.) Start Eclipse
57+
1. Start Eclipse
6058

61-
2.) Import the Maven project into Eclipse
62-
File->Import->Existing Maven Projects
63-
Select <Next> and for the "root directory" select the parent directory for the pom.xml file.
64-
The project should be imported successfully
59+
2. Import the Maven project into Eclipse
60+
* File->Import->Existing Maven Projects
61+
* Select Next and for the "root directory" select the parent directory for the pom.xml file.
62+
* The project should be imported successfully.
6563

66-
3.) Run the tests
67-
Right click the project root (fuml)
68-
->Run As->Maven test
64+
3. Run the tests
65+
* Right click the project root (fuml)
66+
* Run As->Maven test
6967

70-
4.) Install
71-
Right click the project root (fuml)
72-
->Run As->Maven install
68+
4. Install
69+
* Right click the project root (fuml)
70+
* Run As->Maven install
7371

74-
Testing
75-
-------
72+
###Testing
7673

7774
1. In a Windows/DOS command window, navigate to the 'root' reference
78-
implementation directory. This directory is where the Apache Ant 'build.xml'
75+
implementation directory. This directory is where the Apache Maven 'pom.xml'
7976
file can be found.
8077

8178
2. Use the following command:
8279

83-
mvn test
80+
mvn test
8481

8582
The test output can be found in the 'target/surefire-reports'
8683
directory.
@@ -89,45 +86,44 @@ directory.
8986
Testing individual JUnit tests in Eclipse:
9087

9188
1. Right-click on any file under the 'src/test/java' folder with a filename ending in
92-
'TestCase' or 'Test' and select Run As->JUnit Test. The test should execute and
93-
display output.
94-
89+
'TestCase' or 'Test'
90+
2. Run As->JUnit Test.
91+
3. The test should execute and display output.
9592

96-
Deploying
97-
---------
93+
###Deploying
9894

9995
1. In a Windows/DOS command window, navigate to the 'root' reference
100-
implementation directory. This directory is where the Apache Ant 'build.xml'
96+
implementation directory. This directory is where the Apache Maven 'pom.xml'
10197
file can be found.
10298

10399
2. Use the following command:
104100

105-
mvn install
101+
mvn install
106102

107103
A binary deployment 'zip' file will be created and expanded onto the current
108104
drive's root directory. The deployment directory will be called:
109105
'fuml-[version string]-distribution'
110106

111-
112-
113-
Running
114-
-------
107+
###Running
115108

116109
1. In a Windows/DOS command window, navigate to the 'bin' directory for the
117110
DEPLOYED implementation. The implementation can only be run from a DEPLOYED
118111
binary or source distribution (see above).
119112

120-
2. To load a UML model file (XMI 2.1 format) and execute one or more behaviors
113+
2. To load a UML model file (XMI 2.1 or 2.4.1/2.5 format) and execute one or more behaviors
121114
(activities), use the following command:
122115

123-
fuml <model-file> [<behavior-name> <behavior-name> <behavior-name> \<...>]
116+
fuml <model-file> [<behavior-name> <behavior-name> <behavior-name> <...>]
117+
118+
Where:
124119

125-
Where:
126-
<model-file> is UML model file (XMI 2.1 format)
127-
<behavior-name> is a named behavior within the model-file
120+
* `<model-file>` is UML model file (XMI 2.1 or 2.4.1/2.5 format)
121+
122+
* `<behavior-name>` is a named behavior within the model-file
128123

129-
If no behavior name is given, then there should be only a single behavior in the
124+
If no behavior name is given, then there should be only a single behavior in the
130125
top-level namespace of the model, and this is what is executed.
131126

132127
3. The execution trace will print to the console. This may be redirected to a
133128
file if desired (e.g., by appending '> trace.txt' to the command above).
129+

0 commit comments

Comments
 (0)