From 4e9d99185f85bf49bc4a8d6a9c7eae80f68ec448 Mon Sep 17 00:00:00 2001 From: shawnkai <e0525991@u.nus.edu> Date: Mon, 19 Sep 2022 16:56:36 +0800 Subject: [PATCH] edit user guide --- docs/README.md | 31 +++++++------------------------ 1 file changed, 7 insertions(+), 24 deletions(-) diff --git a/docs/README.md b/docs/README.md index 3716fd3aaa..c28961b74f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,10 +1,10 @@ -#User Guide +# User Guide -##Duke +## Duke > “Your mind is for having ideas, not holding them.” – David Allen -###Overview +### Overview Duke frees your mind of having to remember things you need to do. It's, - text-based @@ -19,36 +19,19 @@ All you need to do is, 4. let it manage your tasks for you :+1: And it is FREE! -###Features: +### Features: - [x] Managing tasks - [x] Managing deadlines - [x] Reminders ~~(coming soon)~~ -If you are a Java programmer, you can use it to practice Java too. Here's the `main` method: -```java - public static void main(String[] args) throws IOException { - Storage storage = new Storage(); - TaskList tasks = storage.loadFile(); - Parser parser = new Parser(tasks, storage); - UI ui = new UI(); - ui.welcomeUser(); - String input = ui.readInput(); // Read user input - while (!input.equals("bye")) { - parser.parse(input); - input = ui.readInput(); // Read next user input - } - ui.sayBye(); - } -``` +### Usage -###Usage - -####Commands +#### Commands - `todo DESCRIPTION`: Add todo task -- `deadline DESCRIPTION /by DEADLINE': Add deadline task +- `deadline DESCRIPTION /by DEADLINE`: Add deadline task - `event DESCRIPTION /at TIME`: Add event task - `list`: List all tasks - `mark INDEX`: Mark task as done