Merge pull request #25 from BradF-99/docs-report

Final version of report complete

README.md

@@ -2,11 +2,11 @@
 
 [![Build Status](https://travis-ci.com/BradF-99/CAB302-Assignment2.svg?token=RmWc9zzyFjnuzmgBsmgB&branch=master)](https://travis-ci.com/BradF-99/CAB302-Assignment2)
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/e2cb98918a2f44cc9795e38a9c0f7bfb)](https://www.codacy.com?utm_source=github.com&utm_medium=referral&utm_content=BradF-99/CAB302-Assignment2&utm_campaign=Badge_Grade)
-[![Gitter](https://badges.gitter.im/CAB302-Group369/community.svg)](https://gitter.im/CAB302-Group369/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 
-Assignment 2 (Vector Design Tool) for CAB302, Semester 1, 2019.   
+Assignment 2 (Vector Design Tool) for QUT's CAB302 unit (Software Development), Semester 1, 2019.   
 Built to Assignment Specification v1.0, current as of 2019-06-02.
 
+
 ## Authors
 
 * Alex Butler (Assasindie)
@@ -20,12 +20,17 @@ Built to Assignment Specification v1.0, current as of 2019-06-02.
     * TravisCI runs Ant commands in this order (these can be seen in the build.xml file):
         1. `init` - initialises folders for build
         2. `compile` - compiles all Java in `src/` folder
-        3. `test` - runs all tests in the `src/tests` folder that end with `Tests.class`. **If any tests fail TravisCI will stop immediately.**
+        3. `test` - runs all tests in the `src/tests` folder that end with `Tests.class`. **If any tests fail TravisCI 
+        will stop immediately.**
         4. `dist` - packages the compiled Java in to a JAR file
         5. `clean` - deletes any build artifacts (mainly the `out/` folder).
 * JUnit Jupiter 5.5.0 and JUnit Jupiter 1.5.0 are used for unit testing.
     * For development purposes, these are located in the *lib* folder.
-    * For TravisCI, all dependencies are downloaded during TravisCI's install phase and do not need to be included in the repository.
+    * For TravisCI, all dependencies are downloaded during TravisCI's install phase and do not need to be included in 
+    the repository.
+* OpenJFX 11.0.2 is used for the user interface.
+    * This can be downloaded [from here](https://gluonhq.com/products/javafx/).
+    * It must be added to the IntelliJ project in order for the project to compile successfully.
 * IntelliJ 2019.1.3 is used for development. 
 * pdfTeX 3.14159265-2.6-1.40.19 (TeX Live 2018) is used for compiling supporting documentation.
 
@@ -34,9 +39,17 @@ Built to Assignment Specification v1.0, current as of 2019-06-02.
 * When making changes, please create a new branch and then make a pull request when complete.
     * TravisCI will automatically complete unit tests after PR creation.
         * It will also complete continuous integration testing (testing your changes against master branch).
-    * Codacy will only check Brad's commits due to limitations of the platform. Therefore, Codacy is not required for a pull request to be merged.
-* Assuming all testing passes, any changes to master will result in TravisCI automatically deploying the build to [GitHub Releases](https://github.com/BradF-99/CAB302-Assignment2/releases) and tagging the commit.
+    * Codacy will only check Brad's commits due to limitations of the platform. Therefore, Codacy is not required for a 
+    pull request to be merged.
+* Assuming all testing passes, any changes to master will result in TravisCI automatically deploying the build to 
+[GitHub Releases](https://github.com/BradF-99/CAB302-Assignment2/releases) and tagging the commit.
     * Releases before assignment due date will be denoted as 0.(TravisCI Build Number) - for example, 0.119.
-    * Ideally, the final version before submitting the assignment will be version 1.0 - this will be manually set before submission.
-* Unfortunately, due to limitations with Apache Ant 1.10.6 and JUnit Jupiter 5, we are unable to automatically calculate code coverage during CI/CD. 
-    * However, you can still do this yourself by running your tests using IntelliJ's coverage engine.
+    * Ideally, the final version before submitting the assignment will be version 1.0 - this will be manually set before
+     submission.
+* Unfortunately, due to limitations with Apache Ant 1.10.6 and JUnit Jupiter 5, we are unable to automatically calculate
+ code coverage during CI/CD. 
+    * However, you can still do this yourself by running your tests using IntelliJ's coverage engine.
+* This project was designed for a fictional use-case in a university assignment, and may not be production-ready. 
+Re-use and/or modification are not allowed in any circumstances. All rights reserved.
+* This project (in it's entirety) has been processed by the QUT MoSS system, and any plagiarism will be detected 
+automatically.

build.xml

@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project name="CAB302-Assignment2" default="build" basedir=".">
 
-    <fail message="Ant 1.10.4+ is required!">
+    <fail message="Ant 1.10.5+ is required!">
         <condition>
             <not>
-                <antversion atleast="1.10.4"/>
+                <antversion atleast="1.10.5"/>
             </not>
         </condition>
     </fail>