Skip to content

Commit f4cb39b

Browse files
committed
Add more information and structure to readme
1 parent 7987dae commit f4cb39b

3 files changed

Lines changed: 31 additions & 10 deletions

File tree

File renamed without changes.

README

Lines changed: 0 additions & 10 deletions
This file was deleted.

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Eclipse BaSyx Java SDK
2+
[![BaSyx Logo](https://www.eclipse.org/basyx/img/basyxlogo.png)](https://www.eclipse.org/basyx/)
3+
4+
The Eclipse BaSyx Java SDK is part of the [Eclipse BaSyx middleware](https://www.eclipse.org/basyx/). The SDK has been created within the [BaSys](https://www.basys40.de/) project.
5+
6+
## Eclipse Wiki
7+
A detailed technical and user documentation can be found in the [Eclipse BaSyx wiki](https://wiki.eclipse.org/BaSyx). For the Java SDK, you can find instructions about [how to install](https://wiki.eclipse.org/BaSyx_/_Download_/_Java_Setup) and find [introductory](https://wiki.eclipse.org/BaSyx_/_Introductory_Examples) and [extended](https://wiki.eclipse.org/BaSyx_/_Examples) code examples and further [scenarios](https://wiki.eclipse.org/BaSyx_/_Scenarios). Also, see the description of the individual [components and their API](https://wiki.eclipse.org/BaSyx_/_Documentation_/_API).
8+
9+
## Blog posts
10+
11+
For further information, you may also read the blog posts about the Industrie 4.0 IT Infrastructure for Digital Twins:
12+
- Part 1 - [Building the Industry 4.0 IT Infrastructure for Digital Twins](https://www.iese.fraunhofer.de/blog/industry-4-0-it-infrastructure-for-digital-twins/)
13+
- Part 2 - [Implementing the Industrie 4.0 IT Infrastructure for Digital Twins](https://www.iese.fraunhofer.de/blog/industrie-4-0-it-infrastructure-for-digital-twins-part2/).
14+
15+
## Video documentation
16+
17+
Additionally, you can also find videos explaining the BaSyx middleware on youtube:
18+
19+
[![BaSyx-Middleware – easily explained with the model factory](http://img.youtube.com/vi/bMY8FLhjjRI/mqdefault.jpg)](http://www.youtube.com/watch?v=bMY8FLhjjRI)
20+
21+
*BaSyx-Middleware – easily explained with the model factory*
22+
23+
[![How to make Industrie 4.0 easy with our BaSyx middleware](http://img.youtube.com/vi/kx2F5E5foLU/mqdefault.jpg)](http://www.youtube.com/watch?v=kx2F5E5foLU)
24+
25+
*How to make Industrie 4.0 easy with our BaSyx middleware*
26+
27+
## Contributing
28+
29+
If you would like to contribute, please notice the [contribution guidelines](CONTRIBUTING.md). The overall process is described in the [Eclipse wiki](https://wiki.eclipse.org/BaSyx_/_Developer_/_Contributing).
30+
31+
This GitHub project is migrated from the Eclipse infrastructure. For the archived history, see the [previous repository](https://git.eclipse.org/c/basyx/basyx.git/).

0 commit comments

Comments
 (0)