mirror of
https://github.com/praktimarc/kst4contest.git
synced 2026-03-29 20:20:56 +02:00
README.MD Updated
This commit is contained in:
40
README.md
40
README.md
@@ -1,2 +1,38 @@
|
|||||||
# kst4contest
|
# KST4Contest
|
||||||
java based on4kst chatclient
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
[](https://github.com/praktimarc/kst4contest/actions/workflows/github-wiki.yml)
|
||||||
|
|
||||||
|
[](https://github.com/praktimarc/kst4contest/actions/workflows/docs-pdf.yml)
|
||||||
|
|
||||||
|
Builds:
|
||||||
|
|
||||||
|
[](https://github.com/praktimarc/kst4contest/actions/workflows/nightly-artifacts.yml)
|
||||||
Reference in New Issue
Block a user