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

Commit 1bb2426

Browse files
committed
# Conflicts: # README.md
2 parents 3321278 + 2b883e7 commit 1bb2426

File tree

1 file changed

+58
-58
lines changed

1 file changed

+58
-58
lines changed

README.md

Lines changed: 58 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,58 @@
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-
You can build the project using Maven by simply executing at the repository
13-
root:
14-
15-
`mvn clean install`
16-
17-
or by integrating the respective modules as dependencies, for instance:
18-
19-
```
20-
<dependency>
21-
<groupId>io.admin-shell.aas</groupId>
22-
<artifactId>dataformat-json</artifactId>
23-
<version>latest-version</version>
24-
<dependency>
25-
```
26-
> **_NOTE:_** The library is yet not available as dependency but will be deployed via Maven Central in the future.
27-
28-
# Project Structure
29-
30-
The project contains several modules:
31-
32-
- `dataformat-parent` Maven parent module that contains the respective de-/serializers for the different data formats.
33-
- `dataformat-core` Location of the general classes and interfaces that are used by more than one de-/serializer.
34-
- `dataformat-aasx` AASX de-/serializer
35-
- `dataformat-json` JSON de-/serializer
36-
- `dataformat-xml` XML de-/serializer
37-
38-
39-
40-
# How to Contribute
41-
42-
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).
43-
44-
45-
# Contributors
46-
47-
| Name | Affiliation | Github Account | parent | core | aasx | json | xml |
48-
--- | --- | --- | :---: | :---: | :---: | :---: | :---:
49-
| Mohammad Alreeni | Fraunhofer IWU | []() | | | | | x |
50-
| Sebastian Bader | Fraunhofer IAIS | [sebbader](https://github.com/sebbader) | x | | | | |
51-
| Matthias Böckmann | Fraunhofer IAIS | [maboeckmann](https://github.com/maboeckmann) | x | | | | |
52-
| Maximilian Conradi | Fraunhofer IESE | []() | | | x | | x |
53-
| Daniel Espen | Fraunhofer IESE | []() | | x |x | x | x |
54-
| Michael Jacoby | Fraunhofer IOSB| [mjacoby](https://github.com/mjacoby) | x | x | | x | x |
55-
| Jens Müller | Fraunhofer IOSB | [JensMueller2709](https://github.com/JensMueller2709) | | | | x | |
56-
| Bastian Rössl | Fraunhofer IOSB-INA | []() | | | | x | |
57-
| Frank Schnicke | Fraunhofer IESE | []() | | | x | | x |
58-
| Arno Weiss | Fraunhofer IWU | []() | | | | x | |
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+
You can build the project using Maven by simply executing at the repository
13+
root:
14+
15+
`mvn clean install`
16+
17+
or by integrating the respective modules as dependencies, for instance:
18+
19+
```
20+
<dependency>
21+
<groupId>io.admin-shell.aas</groupId>
22+
<artifactId>dataformat-json</artifactId>
23+
<version>latest-version</version>
24+
<dependency>
25+
```
26+
> **_NOTE:_** The library is yet not available as dependency but will be deployed via Maven Central in the future.
27+
28+
# Project Structure
29+
30+
The project contains several modules:
31+
32+
- `dataformat-parent` Maven parent module that contains the respective de-/serializers for the different data formats.
33+
- `dataformat-core` Location of the general classes and interfaces that are used by more than one de-/serializer.
34+
- `dataformat-aasx` AASX de-/serializer
35+
- `dataformat-json` JSON de-/serializer
36+
- `dataformat-xml` XML de-/serializer
37+
38+
39+
40+
# How to Contribute
41+
42+
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).
43+
44+
45+
# Contributors
46+
47+
| Name | Affiliation | Github Account | parent | core | aasx | json | xml |
48+
--- | --- | --- | :---: | :---: | :---: | :---: | :---:
49+
| Mohammad Alreeni | Fraunhofer IWU | []() | | | | | x |
50+
| Sebastian Bader | Fraunhofer IAIS | [sebbader](https://github.com/sebbader) | x | | | | |
51+
| Matthias Böckmann | Fraunhofer IAIS | [maboeckmann](https://github.com/maboeckmann) | x | | | | |
52+
| Maximilian Conradi | Fraunhofer IESE | []() | | | x | | x |
53+
| Daniel Espen | Fraunhofer IESE | [daespen](https://github.com/daespen) | | x | x | x | x |
54+
| Michael Jacoby | Fraunhofer IOSB| [mjacoby](https://github.com/mjacoby) | x | x | | x | x |
55+
| Jens Müller | Fraunhofer IOSB | [JensMueller2709](https://github.com/JensMueller2709) | | | | x | |
56+
| Bastian Rössl | Fraunhofer IOSB-INA | []() | | | | x | |
57+
| Frank Schnicke | Fraunhofer IESE | [frankschnicke](https://github.com/frankschnicke) | | | x | | x |
58+
| Arno Weiss | Fraunhofer IWU | []() | | | | x | |

0 commit comments

Comments
 (0)