Skip to content
This repository was archived by the owner on Feb 15, 2024. It is now read-only.

Commit f99a58c

Browse files
br-iosbbr-iosb
authored
Merge branch 'main' into main
2 parents 0426fbc + 145703d commit f99a58c

1 file changed

Lines changed: 71 additions & 71 deletions

File tree

‎README.md‎

Lines changed: 71 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,71 @@
1-
# Java Dataformat Library
2-
3-
The AAS Java Dataformat Library is a collection of software modules to serialize and
4-
deserialze instances of the Asset Administration Shell from and to Java
5-
instances. De-/serialization works according to the dataformat schemas published in
6-
the document 'Details of the Asset Administration Shell', published on
7-
[www.plattform-i40.de](https://www.plattform-i40.de).
8-
9-
10-
# Build and Use
11-
12-
Some examples can be found on the [documentation webpage](https://admin-shell-io.github.io/java-serializer/).
13-
14-
You can build the project using Maven by simply executing at the repository
15-
root:
16-
17-
`mvn clean package`
18-
19-
or by integrating the respective modules as dependencies from Maven Central Repository, for instance:
20-
21-
```
22-
<dependency>
23-
<groupId>io.admin-shell.aas</groupId>
24-
<artifactId>dataformat-json</artifactId>
25-
<version>latest-version</version>
26-
<dependency>
27-
```
28-
29-
# Project Structure
30-
31-
The project contains several modules:
32-
33-
- `dataformat-parent` Maven parent module that contains the respective de-/serializers for the different data formats.
34-
- `dataformat-core` Location of the general classes and interfaces that are used by more than one de-/serializer.
35-
- `dataformat-aasx` AASX de-/serializer
36-
- `dataformat-json` JSON de-/serializer
37-
- `dataformat-rdf` RDF de-/serializer
38-
- `dataformat-xml` XML de-/serializer
39-
- `dataformat-uanodeset` OPC UA I4AAS NodeSet de-/serializer
40-
- `dataformat-aml` AutomationML serializer (deserializer is currently under development)
41-
42-
Additionally, the sources that are used for generating the static documentation using [DocFX](https://dotnet.github.io/docfx/) in the `gh-pages` branch are located in the `docs` folder.
43-
44-
45-
46-
# How to Contribute
47-
48-
We always look for contributions, bug reports, feature requests etc. Simply open an [issue](https://github.com/admin-shell-io/java-serializer/issues) or - even better - directly propose a change through a [pull request](https://github.com/admin-shell-io/java-serializer/pulls).
49-
50-
51-
# Contributors
52-
53-
| Name | Affiliation | Github Account | Parent | Core | AASX | JSON | XML | RDF | UA-Nodeset | Validator| AutomationML
54-
--- | --- | --- | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---:
55-
| Mohammad Alreeni | Fraunhofer IWU | []() | | | | | x | | | |
56-
| Sebastian Bader | Fraunhofer IAIS | [sebbader](https://github.com/sebbader) | x | | | | | x | | x | |
57-
| Matthias Böckmann | Fraunhofer IAIS | [maboeckmann](https://github.com/maboeckmann) | x | | | | | x | | x | |
58-
| Maximilian Conradi | Fraunhofer IESE | []() | | | x | | x | | | | |
59-
| Helge Dickel | SAP SE | [heldic](https://github.com/heldic) | x | | | x | x | | | | |
60-
| Daniel Espen | Fraunhofer IESE | [daespen](https://github.com/daespen) | | x | x | x | x | | | | |
61-
| Michael Jacoby | Fraunhofer IOSB| [mjacoby](https://github.com/mjacoby) | x | x | | x | x | | | | x |
62-
| Jens Müller | Fraunhofer IOSB | [JensMueller2709](https://github.com/JensMueller2709) | | | | x | | | | | x |
63-
| Orthodoxos Kipouridis | SAP SE | [akiskips](https://github.com/akiskips) | x | | | x | x | | | | |
64-
| Bastian Rössl | Fraunhofer IOSB-INA | [br-iosb](https://github.com/br-iosb) | | | | x | | | x | | |
65-
| Frank Schnicke | Fraunhofer IESE | [frankschnicke](https://github.com/frankschnicke) | | | x | | x | | | x | |
66-
| Manuel Sauer | SAP SE | [Manu3756](https://github.com/Manu3756) | x | | | | | | | | |
67-
| Arno Weiss | Fraunhofer IWU | [alw-iwu](https://github.com/alw-iwu) | | | | x | | | x | | |
68-
| Jan Blume | Fraunhofer IOSB | []() | | | | | | | | | x |
69-
70-
This project was initiated by SAP and Fraunhofer to provide a foundation for the
71-
AAS development and to foster its dissemination.
1+
# Java Dataformat Library
2+
3+
The AAS Java Dataformat Library is a collection of software modules to serialize and
4+
deserialze instances of the Asset Administration Shell from and to Java
5+
instances. De-/serialization works according to the dataformat schemas published in
6+
the document 'Details of the Asset Administration Shell', published on
7+
[www.plattform-i40.de](https://www.plattform-i40.de).
8+
9+
10+
# Build and Use
11+
12+
Some examples can be found on the [documentation webpage](https://admin-shell-io.github.io/java-serializer/).
13+
14+
You can build the project using Maven by simply executing at the repository
15+
root:
16+
17+
`mvn clean package`
18+
19+
or by integrating the respective modules as dependencies from Maven Central Repository, for instance:
20+
21+
```
22+
<dependency>
23+
<groupId>io.admin-shell.aas</groupId>
24+
<artifactId>dataformat-json</artifactId>
25+
<version>latest-version</version>
26+
<dependency>
27+
```
28+
29+
# Project Structure
30+
31+
The project contains several modules:
32+
33+
- `dataformat-parent` Maven parent module that contains the respective de-/serializers for the different data formats.
34+
- `dataformat-core` Location of the general classes and interfaces that are used by more than one de-/serializer.
35+
- `dataformat-aasx` AASX de-/serializer
36+
- `dataformat-json` JSON de-/serializer
37+
- `dataformat-rdf` RDF de-/serializer
38+
- `dataformat-xml` XML de-/serializer
39+
- `dataformat-uanodeset` OPC UA I4AAS NodeSet de-/serializer
40+
- `dataformat-aml` AutomationML serializer (deserializer is currently under development)
41+
42+
Additionally, the sources that are used for generating the static documentation using [DocFX](https://dotnet.github.io/docfx/) in the `gh-pages` branch are located in the `docs` folder.
43+
44+
45+
46+
# How to Contribute
47+
48+
We always look for contributions, bug reports, feature requests etc. Simply open an [issue](https://github.com/admin-shell-io/java-serializer/issues) or - even better - directly propose a change through a [pull request](https://github.com/admin-shell-io/java-serializer/pulls).
49+
50+
51+
# Contributors
52+
53+
| Name | Affiliation | Github Account | Parent | Core | AASX | JSON | XML | RDF | UA-Nodeset | Validator| AutomationML
54+
--- | --- | --- | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---:
55+
| Mohammad Alreeni | Fraunhofer IWU | []() | | | | | x | | | |
56+
| Sebastian Bader | Fraunhofer IAIS | [sebbader](https://github.com/sebbader) | x | | | | | x | | x | |
57+
| Matthias Böckmann | Fraunhofer IAIS | [maboeckmann](https://github.com/maboeckmann) | x | | | | | x | | x | |
58+
| Maximilian Conradi | Fraunhofer IESE | []() | | | x | | x | | | | |
59+
| Helge Dickel | SAP SE | [heldic](https://github.com/heldic) | x | | | x | x | | | | |
60+
| Daniel Espen | Fraunhofer IESE | [daespen](https://github.com/daespen) | | x | x | x | x | | | | |
61+
| Michael Jacoby | Fraunhofer IOSB| [mjacoby](https://github.com/mjacoby) | x | x | | x | x | | | | x |
62+
| Jens Müller | Fraunhofer IOSB | [JensMueller2709](https://github.com/JensMueller2709) | | | | x | | | | | x |
63+
| Orthodoxos Kipouridis | SAP SE | [akiskips](https://github.com/akiskips) | x | | | x | x | | | | |
64+
| Bastian Rössl | Fraunhofer IOSB-INA | [br-iosb](https://github.com/br-iosb) | | | | x | | | x | | |
65+
| Frank Schnicke | Fraunhofer IESE | [frankschnicke](https://github.com/frankschnicke) | | | x | | x | | | x | |
66+
| Manuel Sauer | SAP SE | [Manu3756](https://github.com/Manu3756) | x | | | | | | | | |
67+
| Arno Weiss | Fraunhofer IWU | [alw-iwu](https://github.com/alw-iwu) | | | | x | | | x | | |
68+
| Jan Blume | Fraunhofer IOSB | []() | | | | | | | | | x |
69+
70+
This project was initiated by SAP and Fraunhofer to provide a foundation for the
71+
AAS development and to foster its dissemination.

0 commit comments

Comments
 (0)