summaryrefslogtreecommitdiffstats
path: root/src/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/readme.md')
-rw-r--r--src/readme.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/src/readme.md b/src/readme.md
new file mode 100644
index 0000000..dc4bebb
--- /dev/null
+++ b/src/readme.md
@@ -0,0 +1,17 @@
+# esotericFORTRAN
+
+## Setup
+
+Get build dependencies if using Linux or WSL
+
+`sudo apt install default-jdk default-jre gcc`
+
+Compile
+
+`make`
+
+## Example usage
+
+`java -jar esotericFORTRAN.jar example.txt -c -pc -e`
+
+Full documentaion is avaliable at `Compiler/helptext.txt` or `java -jar esotericFORTRAN.jar --help`