diff --git a/README.md b/README.md index fd2d0cb9cf..0304f754cc 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# plato.Plato project template +# Plato project template -This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it. +This is a project template for a greenfield Java project. It's inspired after the Java mascot _Duke_. Given below are instructions on how to use it. ## Setting up in Intellij @@ -13,12 +13,13 @@ Prerequisites: JDK 11, update Intellij to the most recent version. 1. If there are any further prompts, accept the defaults. 1. Configure the project to use **JDK 11** (not other versions) as explained in [here](https://www.jetbrains.com/help/idea/sdk.html#set-up-jdk).
In the same dialog, set the **Project language level** field to the `SDK default` option. -3. After that, locate the `src/main/java/plato.Plato.java` file, right-click it, and choose `Run plato.Plato.main()` (if the code editor is showing compile errors, try restarting the IDE). If the setup is correct, you should see something like the below as the output: +3. After that, locate the `src/main/java/plato/Launcher.java` file, right-click it, and choose `Run plato.Launcher.main()` (if the code editor is showing compile errors, try restarting the IDE). If the setup is correct, you should see a GUI window. ``` Hello from - ____ _ - | _ \ _ _| | _____ - | | | | | | | |/ / _ \ - | |_| | |_| | < __/ - |____/ \__,_|_|\_\___| - ``` + .______ __ ___ .___________. ______ + | _ \ | | / \ | | / __ \ + | |_) | | | / ^ \ `---| |----`| | | | + | ___/ | | / /_\ \ | | | | | | + | | | `----./ _____ \ | | | `--' | + | _| |_______/__/ \__\ |__| \______/ + ``` \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index 2e1c0a5686..40fa9e3d31 100644 --- a/docs/README.md +++ b/docs/README.md @@ -84,7 +84,7 @@ Examples: * `event cs2103 planning /from 1800 24/02/24 /to 1900 27/02/24` -* `event midterm study session /from 01:00pm 28-02-24 /to 02:00pm 30-02-24` +* `event midterm study session /from 01:00pm 28-02-24 /to 02:00pm 01-03-24` Expected outcome: ``` diff --git a/src/main/java/plato/parser/Parser.java b/src/main/java/plato/parser/Parser.java index 21dfe6b5e9..1c6fab13f7 100644 --- a/src/main/java/plato/parser/Parser.java +++ b/src/main/java/plato/parser/Parser.java @@ -60,7 +60,8 @@ public static String[] parse(String command, TaskManager manager) throws PlatoEx /** - * @return Whether plato should close the chat-bot. + * Checks if should close the bot. + * @return Whether plato should close the chat bot. */ public static boolean isExit() { return isDead; diff --git a/src/main/java/plato/task/Actions.java b/src/main/java/plato/task/Actions.java index a874b30d0b..15fa86c3ca 100644 --- a/src/main/java/plato/task/Actions.java +++ b/src/main/java/plato/task/Actions.java @@ -1,7 +1,7 @@ package plato.task; /** - * Actions indicate teh type of task + * Actions indicate the type of task. */ public enum Actions { TODO, DEADLINE, EVENT diff --git a/src/main/java/plato/task/Todo.java b/src/main/java/plato/task/Todo.java index 8d370f16d0..a863658283 100644 --- a/src/main/java/plato/task/Todo.java +++ b/src/main/java/plato/task/Todo.java @@ -1,6 +1,5 @@ package plato.task; - /** * Create a todo class that only has a name. */