diff --git a/README.md b/README.md index 8715d4d91..1e5ea64be 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Duke project template +# Duke 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. @@ -17,7 +17,7 @@ Prerequisites: JDK 11, update Intellij to the most recent version. ``` Hello from ____ _ - | _ \ _ _| | _____ + | _ \ _ _| | _____ | | | | | | | |/ / _ \ | |_| | |_| | < __/ |____/ \__,_|_|\_\___| diff --git a/data/brave.txt b/data/brave.txt new file mode 100644 index 000000000..8fb79feed --- /dev/null +++ b/data/brave.txt @@ -0,0 +1,5 @@ +T , 1 , read book +D , 1 , return book , June 6th +E , 0 , project meeting , Aug 6th 2-4pm +T , 1 , join sports club +T , 0 , cs2113 lecture diff --git a/docs/README.md b/docs/README.md index 8077118eb..6ec078cc3 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,29 +1,217 @@ # User Guide +Brave is a **Command Line Interface (CLI) application** for you to manage your daily task +Todo - Event - Deadline + +- [Quick Start](#quick-start) +- [Features](#features) + - [Adding a Todo: `todo`](#adding-a-todo-todo) + - [Adding a Deadline: `deadline`](#adding-a-deadline-deadline) + - [Adding an Event: `event`](#adding-an-event-event) + - [Listing all tasks: `list`](#listing-out-all-tasks-list) + - [Marking a task as done: `mark`](#marking-a-task-as-completed-mark) + - [Marking a task as incomplete : `unmark`](#marking-a-task-as-incomplete-unmark) + - [Deleting a task: `delete`](#deleting-a-task-delete) + - [Searching for tasks: `find`](#searching-for-tasks-find) + - [Exiting the program: `bye`](#exiting-the-program-bye) + +## Quick Start +1. Prerequisites: JDK 11, update Intellij to the most recent version. +2. Download the latest copy of `ip.jar` from the [Releases](https://github.com/johnsuharjono/ip/releases) page. +3. Open your Command Prompt (Windows) or Terminal (Mac/Linux), and navigate to the folder you created. +4. Run the command `java -jar ip.jar`, this will be shown in your terminal if successfull + ``` + -*|Brave|*------------------------------------ + Greetings from + ____ _ + | __ ) _ __ __ ___ _____ | | + | _ \| '__/ _` \ \ / / _ \ | | + | |_) | | | (_| |\ V / __/ |_| + |____/|_| \__,_| \_/ \___| (_) + + What can I do for you? + ---------------------------------------------- + ``` + ## Features -### Feature-ABC +### Adding a Todo: `todo` + +Create a To-Do type task + +**Format:** `todo ` + +**Example Input:** +``` +todo learn web development +``` + +**Example Output:** +``` +-*|Brave|*------------------------------------ +Okay! I have added task below! +[T][ ] learn web development +You currently have 6 task in the list +---------------------------------------------- +``` + +### Adding a Deadline: `deadline` + +Create a Deadline type task + +**Format:** `deadline /by