From 4f66b5f51b7c32fec9b7db842bf2860237328333 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ma=C3=ABl=20Gassmann?= <mael.gassmann@students.bfh.ch>
Date: Sat, 12 Jun 2021 15:41:06 +0200
Subject: [~] Wrote the README

---
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 204492d..6131b1c 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,47 @@
 # calculator_gassm14
 
+## Requirements
+
+- java-11-openjdk
+- Apache Maven 3.8.1
+
+## Java Calculator project
+
+### Compilation
+
+Navigate to the calculator-java folder and run:
+
+```
+mvn package
+```
+
+The resulting jar file can then be located in the /target folder.
+
+### Execution
+
+Navigate to the newly generated /target folder and launch the jar:
+
+```
+java -jar calculator-java-1.0-SNAPSHOT.jar
+```
+
+## JavaCC Calculator project
+
+To easily compile and run this project, you will find a file compileRun.sh in its folder.
+If you still prefer to compile and run separatly, you can check out the sections below.
+
+### Compilation
+
+Navigate to the calculator-javacc folder and run:
+
+```
+javacc Calculator.jj && javac *.java
+```
+
+### Execution
+
+In the same folder, execute:
+
+```
+java Calculator
+```
-- 
cgit v1.2.3