Skip to content

Commit 6a2b69c

Browse files
author
Dennis Labordus
committed
Updated MD documents.
Signed-off-by: Dennis Labordus <[email protected]>
1 parent 8659b11 commit 6a2b69c

File tree

3 files changed

+14
-15
lines changed

3 files changed

+14
-15
lines changed

DEVELOPMENT.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@ SPDX-License-Identifier: Apache-2.0
99
## Git
1010

1111
If the project is already cloned and a submodule is added use the following commands to retrieve the files from the
12-
RiseClipse Repository, first `git submodule init` and next `git submodule update`.
12+
RiseClipse Repository:
13+
14+
- `git submodule init`
15+
- `git submodule update`
1316

1417
More about Git Submodules can be found [here](https://git-scm.com/book/en/v2/Git-Tools-Submodules).
1518

@@ -21,9 +24,6 @@ Because of the subdirectory where the submodules are in, this doesn't work exact
2124
to update the URLs locally to HTTPS.
2225

2326
```
24-
git config submodule.riseclipse/riseclipse-developer.url https://github.com/riseclipse/riseclipse-developer.git
25-
git config submodule.riseclipse/riseclipse-main.url https://github.com/riseclipse/riseclipse-main.git
26-
git config submodule.riseclipse/riseclipse-metamodel-scl2003.url https://github.com/riseclipse/riseclipse-metamodel-scl2003.git
2727
git config submodule.riseclipse/riseclipse-ocl-constraints-scl2003.url https://github.com/riseclipse/riseclipse-ocl-constraints-scl2003.git
2828
2929
git submodule init
@@ -39,8 +39,8 @@ in the remote repository execute the following command from the root directory o
3939
git submodule update --remote
4040
```
4141

42-
Next add the changes and commit/push these to the Git Repository of CoMPAS. The build now uses the latest commit of the
43-
main branch.
42+
Next commit and push the changes to the Git Repository of CoMPAS. The build now uses the latest commit of the main
43+
branch.
4444

4545
## Eclipse
4646

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ automatically determine the URL to be used.
2828

2929
## Development
3030

31-
Since version 1.2.x the JAR Files of RiseClipse are distributed on Maven Central Repository. This way the JAR Files can
32-
be retrieved from there and don't need to be build locally anymore. Only the OCL Files for the SCL validation still need
33-
to be downloaded from RiseClipse GIT Repository. This is still done using Git Submodules.
31+
Since version 1.2.x the JAR Files of RiseClipse are distributed through Maven Central Repository. The JAR Files can be
32+
retrieved from there and don't need to be build locally anymore. Only the OCL Files for the SCL validation still need to
33+
be downloaded from RiseClipse GIT Repository. This is still done using Git Submodules.
3434

3535
To clone the project or update the project this means that the Git commands are sometimes a little different. To clone
3636
the project use the following command `git clone --recurse-submodules [email protected]:com-pas/compas-scl-validator.git`.
@@ -40,8 +40,7 @@ Tip: The URL to the submodules are configured in the file `.gitmodules`, but the
4040
described [here](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to overwrite the URL locally with an HTTPS URL of
4141
the GIT Repository.
4242

43-
Check the [Development](DEVELOPMENT.md) page for more detail information how to develop in this repository, because of
44-
the Git submodule and Eclipse Repository needed to make RiseClipse work.
43+
Check the [Development](DEVELOPMENT.md) page for more detail information how to develop in this GIT repository.
4544

4645
## Custom OCL Files
4746

riseclipse/riseclipse-p2-to-m2/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ SPDX-FileCopyrightText: 2022 Alliander N.V.
44
SPDX-License-Identifier: Apache-2.0
55
-->
66

7-
This project is used to create maven artifacts from Eclipse plugins. This is needed for building the executable jar to
8-
run in a Docker Container.
7+
This project is used to create a maven repository from Eclipse Dependencies. This is needed for building the executable
8+
jar to run in a Docker Container.
99

1010
The project is a copy of the p2_to_m2 project
11-
from [RiseClipse Developer](https://github.com/riseclipse/riseclipse-developer)
12-
of the directory 'fr.centralesupelec.edf.riseclipse.developer.p2_to_m2'.
11+
from [RiseClipse Developer](https://github.com/riseclipse/riseclipse-developer) of the
12+
directory `fr.centralesupelec.edf.riseclipse.developer.p2_to_m2`.
1313

1414
The file `src/main/resources/riseclipse.aggr` is also a copy of the file from RiseClipse and can be found
1515
[here](https://github.com/riseclipse/riseclipse-developer/blob/master/fr.centralesupelec.edf.riseclipse.developer.p2_to_m2/src/main/resources/riseclipse.aggr)

0 commit comments

Comments
 (0)