create README.md, part I

This commit is contained in:
2025-09-23 09:11:26 +02:00
parent 316dc60b69
commit 5bea9b27d7
2 changed files with 46 additions and 56 deletions

View File

@@ -1,50 +1,52 @@
# Aufgabenstellung IoT Native Entwicklung
# libPiGPIO
**Abstract**:
Ein Erzeuger generiert Werte die an einen Verbraucher übertragen werden.
Der Verbraucher zeigt die einzelnen Werte in der Konsole an.
Der Erzeuger kann erst neue Werte an den Verbraucher senden, wenn der Verbraucher den Wert verbraucht (ausgegeben) hat.
libPiGPIO: Eine C++ Softwarebibliothek für den Pi4 zur Einbindung elektronischer Steuerelemente
**Feature**:
Der Erzeuger überträgt ein variables Objekt an einen Verbraucher der das Objekt auf der Konsole ausgibt
## Getting started
**Scenario**: Das erzeugte, variable Objekt stellt in der ersten Ausprägung einen Sekunden Zeitwert mit aktuellem Zeitstempel in msec dar
**Given** der aktuelle Zeitwert in Sekunden
**When** das Objekt erstellt wird
**Then** Sekunden Wert und ein Zeitstempel in msec wird in das Objekt eingetragen
**Scenario**: Das Objekt wird an den Verbraucher übertragen
**Given** ein erstelltes Objekt
**When** das Objekt übertragen wird
**Then** wird auf den Verbraucher gewartet bis er das Objekt verarbeiten kann
**Scenario**: Das Objekt ist im Verbraucher angekommen
**Given** ein übertragenes Objekt
**When** das Objekt ausgegeben ist
**Then** wird der Erzeuger informiert ein neues Objekt zu erzeugen
**Scenario**: Das Objekt wird im Verbraucher ausgegeben
**Given** eine übertragenes Objekt
**When** das Objekt ausgegeben wird
**Then** der Wert in Sekunden wird numerisch, der Zeitstempel in lesbarer vollständiger Form, ausgegeben
**Scenario**: Das Objekt wird vom Erzeuger übertragen
**Given** ein erstelltes Objekt
**When** das Objekt übertragen wird
**Then** der Erzeuger wartet bis der Verbraucher eine Erzeugung angefordert hat
**Scenario**: Das Objekt wird übertragen
**Given** ein erstelltes Objekt
**When** das Objekt übertragen wird
**Then** das Objekt wird serialisiert über einen Socket übertragen
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
## Development Guidelines
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
- Die Verwendung von C++ Standards, C11 und neuer
- Die Implementierung soll eine Linux und Windows Plattform abdecken
- Das Build System für die gesamte Anwendung ist CMake
- Die gesamte Anwendung verfügt über Unit Tests die mit google test zu erstellen sind
- Die Versionsverwaltung git ist zu verwenden
- Eine Dokumentation des Anwendungsentwurfs ist verfügbar
- Die Übertragung kann von Sockets auf andere Mechanismen (Shared File) umgestellt werden. Der Impact auf die Anwendung soll begrenzt sein.
## Add your files
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
```
cd existing_repo
git remote add origin http://sourceworx.org:9099/opensource/libpigpio.git
git branch -M main
git push -uf origin main
```
## Integrate with your tools
- [ ] [Set up project integrations](http://sourceworx.org:9099/opensource/libpigpio/-/settings/integrations)
## Collaborate with your team
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
## Test and Deploy
Use the built-in continuous integration in GitLab.
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
***
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.

View File

@@ -1,12 +0,0 @@
# README.md raDIYo
### Eine Mediaplayer-Software für den RaspberryPi, zugleich ein Hardware-Updgrade eines Nora 'Rienzi' Radios, Bj. ca. 1935
Der Raspberry Pi eignet sich mit etwas Zusatzhardware bekanntermaßen hervorragend als Mediaplayer,da lag es nahe, einen Pi4 Internetradio-Wecker zu verwenden.
Impl.
Arch.