aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorkrolxon <krolyxon@tutanota.com>2024-02-17 20:09:05 +0530
committerkrolxon <krolyxon@tutanota.com>2024-02-17 20:09:05 +0530
commitf9c7776aedfd5aa30e7336af7459fd6acf7e6124 (patch)
treeb4243fd51fd982f45a80913de7558c84802e0c56 /README.md
parent46f83731f76ccb703307a9705c5cca93bfaf40d9 (diff)
edit readme and add LICENSE
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/README.md b/README.md
index 3f6d27b..dc0be6f 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,17 @@
-## JavaCalc
+# ['JavaCalc'](https://github.com/krolyxon/cht-rs)
- Simple calculator i made in java to learn expression parsing and Swing UI development.
+Simple GUI calculator with complex infix expression evaluation made in Java using Swing.
+
+## Installation
+
+```bash
+ $ git clone --depth=1 https://github.com/krolyxon/JavaCalc --branch=master
+ $ cd JavaCalc
+ $ ./run.sh
+ ```
+
+## JavaCalc in action
+![](https://raw.githubusercontent.com/krolyxon/JavaCalc/master/asset/screenshot1.png)
+
+## License
+This project is licensed under the [`GPLv3 LICENSE`](https://github.com/krolyxon/JavaCalc/blob/master/LICENSE)