Dave Jarvis' Repositories

git clone https://repo.autonoma.ca/repo/kmcaster.git

Update documentation for ease of use

Author DaveJarvis <email>
Date 2020-07-27 16:48:26 GMT-0700
Commit 5670bfb31022b6c62553561336f4eda4c5b64b5c
Parent 5787ae7
Delta 22 lines added, 0 lines removed, 22-line increase
README.md
* works with emulation software (e.g., [Sikuli](http://sikulix.com/)).
+## Alternatives
+
+* [QKeysOnScreen](https://github.com/ctrlcctrlv/QKeysOnScreen)
+
# Comparison
The following video compares KmCaster to [key-mon](https://github.com/critiqjo/key-mon):
![KmCaster Demo](images/kmcaster-01.gif "Comparison Video")
+
+# Requirements
+
+Java 14.
+
+# Download
+
+Download the latest Java Archive file:
+
+[Download](https://gitreleases.dev/gh/DaveJarvis/kmcaster/latest/kmcaster.jar)
+
+# Running
+
+After installing Java, run the program as follows:
+
+``` bash
+java -jar kmcaster.jar
+```