Skip to content

Enhance README with project purpose and usage #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Ben1991 merged 2 commits into from
Aug 24, 2026
Merged

Enhance README with project purpose and usage #73

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e2f4da5
Enhance README with project purpose and usage
Ben1991 Aug 24, 2026
754f4b7
test: include README purpose sections
Ben1991 Aug 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
[![CI](https://github.com/Ben1991/hvv-anzeiger/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/Ben1991/hvv-anzeiger/actions/workflows/ci.yml)
[![Lizenz: GPL-3.0-only](https://img.shields.io/badge/Lizenz-GPL--3.0--only-blue.svg)](LICENSE)

## Wieso gibt es dieses Projekt?

Ich möchte morgens möglichst schnell sehen, wann ich los muss, um meinen Bus oder meine Bahn zu bekommen - ohne auf mein Handy gucken zu müssen.

## Und wie funktioniert es?

Eine kompakte Abfahrtsanzeige für einen Raspberry Pi Zero 2 W oder ein
kompatibles Raspberry-Pi-Modell mit 40-Pin-GPIO und ein
2,2-Zoll-ILI9341-SPI-Display. Sie läuft ohne grafische Oberfläche auf
Expand Down
2 changes: 2 additions & 0 deletions tests/test_project_artifacts.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ def test_readme_has_open_source_user_journey(self) -> None:
self.assertEqual(
headings,
[
"## Wieso gibt es dieses Projekt?",
"## Und wie funktioniert es?",
"## Praxisbeispiel",
"## Release Notes",
"## Inhalt",
Expand Down
Loading