Added README.md

This commit is contained in:
Thastertyn 2023-05-27 21:29:02 +02:00
parent ae043ccb2f
commit 39c56b74ff

12
README.md Normal file
View File

@ -0,0 +1,12 @@
# Jecnak TUI
An attempt at [Jecnakvkapse](https://github.com/JohnyDaDeveloper/Jecnakvkapse) in a terminal via TUI interface. Currently works only on [spsejecna.cz](https://www.spsejecna.cz), but [Canteen](https://www.spsejecna.cz/jidelna) and [Substitution](https://www.spsejecna.cz/suplovani) maybe coming soon™.
## Running
You need to:
- Download the jar from [releases](https://gitea.thastertyn.xyz/Thastertyn/jecnak-tui/releases)
- Use Java 17 LTS
- Run via GUI, just make sure Java 17 is used,
or using your favorite terminal emulator with `java -jar jecnak-tui.jar`
Have fun with the app