summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorjwansek <eddie.atten.ea29@gmail.com>2021-11-30 17:19:35 +0000
committerjwansek <eddie.atten.ea29@gmail.com>2021-11-30 17:19:35 +0000
commit0f5bb5efa6bc534392cf9b15ed05e7a383ad5e2a (patch)
tree7888afdee421586d4244fa9d329f222744c2093e
parent4fc05152f85d48281c7cfa2821e8a4656d6ed6b0 (diff)
parent1b49df7352f3325ec25c91e167c2a57182ddb826 (diff)
downloadesotericFORTRAN-0f5bb5efa6bc534392cf9b15ed05e7a383ad5e2a.tar.gz
esotericFORTRAN-0f5bb5efa6bc534392cf9b15ed05e7a383ad5e2a.zip
Merge branch 'main' of https://github.com/AlfieEagleton/EsotericProject into main
-rw-r--r--README.md8
-rw-r--r--src/readme.md11
2 files changed, 16 insertions, 3 deletions
diff --git a/README.md b/README.md
index 0cd2d1b..e91f56a 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,8 @@
# EsotericProject
-Advanced Programming Project.
+Advanced Programming Project
+
+## Todo
+- [ ] Sort out dir structure further (rename example dir to fortran_src, make separate dir for c source files and out files)
+- [ ] Implement functions
+- [ ] UI work
+- [ ] Add section to report about compiler pipeline (ft -> c -> c object -> native binary)
diff --git a/src/readme.md b/src/readme.md
index d6e7a34..a1869d7 100644
--- a/src/readme.md
+++ b/src/readme.md
@@ -10,8 +10,15 @@ Compile
`make`
-## Example usage
+## Example usage (command line)
`java -jar .\esotericFORTRAN.jar .\examples\iteration.ft -c --execute -pc`
-Full documentaion is avaliable at `Compiler/helptext.txt` or `java -jar esotericFORTRAN.jar --help`
+Full documentation is available at `Compiler/helptext.txt` or `java -jar esotericFORTRAN.jar --help`
+
+To run the compiler using Intellij, navigate to the 'edit configurations' tab
+and place command line arguments in the CLI arguments box
+The working directory is `src`, so the following is equivelent to the options
+above:
+
+`examples/example.ft -c -pc -e` \ No newline at end of file