From 7be9184e30167960609a65afa31287ded3bfec30 Mon Sep 17 00:00:00 2001 From: Rajnish Mishra Date: Sat, 30 May 2020 15:37:28 +0530 Subject: [PATCH] Update Readme,md --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index c1548a1..3918816 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,25 @@ # Keyboard Tester A simple Keyboard Tester in Java to help you while cheking an old or damaged keyboard, to know which keys are working. + +## Building (using ant) + +Requirements: +- JDK 11 +- Apache Ant 1.10.4 (or above) + +The project can be compiled and built using [Netbeans IDE](https://netbeans.apache.org/) as it's the base IDE used for this project. However, apache ant can be used to compile and build the sources. The java executable (jar) can be built directly with `ant` using, +```bash +ant jar +``` +The built java executable (jar) will be available at `dist/KeyboardTester.jar` + +## Running + +If java is integrated in the desktop envirnmont, you can directly double click the jar file to run it. +You can also run the java executable through command line, +```bash +java -jar dist/KeyboardTester.jar +``` + +## License +This project is under [MIT License](LICENSE)