From 4caf60954379915ccc51fd2c1801399dd97c0c89 Mon Sep 17 00:00:00 2001 From: "chris.sutcliffe" Date: Mon, 29 Nov 2021 21:39:25 +0000 Subject: update readme to contain ide usage information --- src/readme.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/src/readme.md b/src/readme.md index dc4bebb..4031f10 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 example.txt -c -pc -e` Full documentaion is avaliable 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 -- cgit v1.2.3 From 2be157e97021cc5a4c102d74e6c5f7ff23768162 Mon Sep 17 00:00:00 2001 From: "chris.sutcliffe" Date: Tue, 30 Nov 2021 12:30:57 +0000 Subject: correct small typo --- src/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/readme.md b/src/readme.md index 0f5da1e..a1869d7 100644 --- a/src/readme.md +++ b/src/readme.md @@ -14,7 +14,7 @@ Compile `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 -- cgit v1.2.3 From 1b49df7352f3325ec25c91e167c2a57182ddb826 Mon Sep 17 00:00:00 2001 From: "chris.sutcliffe" Date: Tue, 30 Nov 2021 15:36:05 +0000 Subject: add todo to readme to keep track --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) 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) -- cgit v1.2.3