From e5b30c3049b8fafe281b61c62048af94fcfb4720 Mon Sep 17 00:00:00 2001 From: Philipp Wagner Date: Fri, 27 Mar 2026 01:20:48 +0100 Subject: [PATCH] README.MD Updated --- README.md | 40 ++++++++++++++++++++++++++++++++++++++-- 1 file changed, 38 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a3136c1..28b3dfe 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,38 @@ -# kst4contest -java based on4kst chatclient +# KST4Contest + +KST4Contest (also known as pratiKST) is a Java-based chat client for ON4KST, focused on VHF/UHF/SHF contest operation. + +## Documentation + +The full user documentation is maintained in the project wiki: + +- https://github.com/praktimarc/kst4contest/wiki + +Direct entry points: + +- German start page: https://github.com/praktimarc/kst4contest/wiki/de-Home +- English start page: https://github.com/praktimarc/kst4contest/wiki/en-Home + +## Build + +Compile locally with Maven Wrapper: + +```bash +./mvnw -B -DskipTests compile +``` + +## Notes + +- Source code is under `src/`. +- Documentation markdown pages for wiki/PDF are under `github_docs/`. + +## Status of the latest CI: +Wiki Publishing: + +[![Publish wiki](https://github.com/praktimarc/kst4contest/actions/workflows/github-wiki.yml/badge.svg)](https://github.com/praktimarc/kst4contest/actions/workflows/github-wiki.yml) + +[![Docs PDF](https://github.com/praktimarc/kst4contest/actions/workflows/docs-pdf.yml/badge.svg)](https://github.com/praktimarc/kst4contest/actions/workflows/docs-pdf.yml) + +Builds: + +[![Nightly Runtime Artifacts](https://github.com/praktimarc/kst4contest/actions/workflows/nightly-artifacts.yml/badge.svg)](https://github.com/praktimarc/kst4contest/actions/workflows/nightly-artifacts.yml) \ No newline at end of file