diff --git a/.gitignore b/.gitignore index 99712178bf..0c78facf79 100644 --- a/.gitignore +++ b/.gitignore @@ -12,3 +12,4 @@ src/main/resources/docs/ .DS_Store *.iml bin/ +src/main/java/META-INF/MANIFEST.MF diff --git a/Duke/data.txt b/Duke/data.txt new file mode 100644 index 0000000000..1f967c739f --- /dev/null +++ b/Duke/data.txt @@ -0,0 +1,2 @@ +T | true | poo +D | true | pie | 2020-12-12 | 1200 diff --git a/README.md b/README.md index 2fd105ed3b..4e491f3b85 100644 --- a/README.md +++ b/README.md @@ -22,11 +22,12 @@ # Tutorials -Duke Increment | Tutorial +Duke.Duke Increment | Tutorial ---------------|--------------- `A-TextUiTesting` | [Text UI Testing Tutorial](tutorials/textUiTestingTutorial.md) + # Feedback, Bug Reports * If you have feedback or bug reports, please post in [se-edu/duke issue tracker](https://github.com/se-edu/duke/issues). diff --git a/Save/data.txt b/Save/data.txt new file mode 100644 index 0000000000..eb5c36b4b2 --- /dev/null +++ b/Save/data.txt @@ -0,0 +1,6 @@ +T | true | read book +D | false | return book | June 6th +E | false | project meeting | Aug 6th 2-4pm +T | false | poo +D | false | return homework | nowT | false | eat +E | false | sleep | tonight diff --git a/docs/README.md b/docs/README.md index fd44069597..2ab6bc481d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,20 +1,99 @@ # User Guide -## Features +## 1. Introduction +Duke - version LISA, is a CLI task scheduler that supports three +different types of tasks (todo, event and deadline). +It is simple to use, and comes with a save function to +remember your -### Feature 1 -Description of feature. +## 2. Quick Start +1. Ensure you have Java 11 or above installed in your Computer -## Usage +1. Download the latest duke.jar -### `Keyword` - Describe action +1. Copy the file to the folder you want to use as the home folder. -Describe action and its outcome. +1. Run the jar file using `java - jar duke.jar` -Example of usage: +## 3. Features -`keyword (optional arguments)` +### 3.1 - Add +There are three types of tasks users can add -Expected outcome: +##### Todo: +* Basic tasks for quick noting down, no date or time required +* **Usage**: `todo ` -`outcome` +##### Event: +* Event type tasks, _date and time required_ +* **Usage**: `event /