From 5725852d451dde98f32b8aff1b45d628e6807bd4 Mon Sep 17 00:00:00 2001
From: "chris.sutcliffe" <ctd.sutcliffe@gmail.com>
Date: Wed, 15 Dec 2021 14:57:58 +0000
Subject: update readme

---
 README.md | 88 +++++++++++++++++----------------------------------------------
 1 file changed, 24 insertions(+), 64 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index e5235a1..fb74c68 100644
--- a/README.md
+++ b/README.md
@@ -1,64 +1,24 @@
-# EsotericProject
-Advanced Programming Project
-
-## Old / code todo
-- [x] Implement functions 
-- [x] UI work
-- [ ] Add section to report about compiler pipeline (ft -> c -> c object -> native binary)
-
-Seciton about how compiler works, how implemented
-
-There is overlap  between chapters 3, 6, 7 and 8
-Split sprints
-
-## Report todo
-Chapter 1:
-- [ ] General expansion needed
-
-Chapter 2:
-- [ ] General expansion
-
-Chapter 3 (Chris):
-- [ ] Talk about overall work
-- [ ] Abstract concepts
-- [ ] Compilers etc
-- [ ] How C compiler works
-- [ ] Talk about recursive descent compiling
-
-
-Chapter 4:
-- [ ] Title change to Language Design
-- [ ] Write up notes in full
-- [ ] Context free grammars
-
-Combine chapter 4 and 5 under full language design section
-
-Chapter 5 and 6 (Alfie):
-- [ ]  Merge chapter 5 and 6
-- [ ] Put stuff about java files in sprint talk
-- [ ] Move abstract stuff i.e. how files were changed into to chapter 3
-- [ ] Unit testing - Chris - talk about sprint 1-3 unit testing abandoned
-
-Chapter 7 (Testing) (Chris)
-- [ ] Write test harnesses
-- [ ] Define what they do in report
-- [ ] Then say they passed (if they do)
-
-
-Dicussion section:
-- [ ] Expand this section of the report
-
-Conclusion (Aiden):
-- [x] Write conclusion
-
-Extra stuff: 
-- [x] UML diagrams: one for each sprint, one final one. Sprint 3 adds execute C
-- [x] String stuff
-- [x] Add strings
-- [ ] Grab screenshots, and make point the software is cross-platform 
-- [x] IDE reload from file
-- [ ] IDE line numbers
-- [ ] IDE icon (https://icon-icons.com/icon/Idea-bulb-light/120562)
-- [ ] IDE comment line using CTRL + /
-- [ ] Add CTRL + Backspace shortcut to remove text 
-
+# EsotericProject (Group 12)
+Esoteric Programming Language (esotericFORTRAN)
+### Group members:
+* Eden Attenborough
+* Alfie Eagleton
+* Aiden Rusbrooke
+* Chris Sutcliffe
+
+## Introduction 
+This repository contains all code created for this project, including the 
+latex source files.
+
+## Running the project
+To run the project, clone the repository and cd into the src directory.
+After this, type `make` in the command line to compile all java code to a jar.
+`make clean` is implemented in the supplied makefile and can be used to remove 
+all source and class files from the build directory.
+
+Once the jar is compiled, navigate to the PythonIDE directory, then run either
+`run_linux.sh` or `run_widnows.bat`, depending on operating system.
+Assuming python and tkinter is installed, the IDE will start. 
+Note: if you are on a Debian based Linux distribution, you will have to the 
+command `sudo apt install python3-tk` to install tkinter!
+Once this is done, you can now write and run FORTRAN code!
-- 
cgit v1.2.3