diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md deleted file mode 100644 index 8e359a0145..0000000000 --- a/CONTRIBUTORS.md +++ /dev/null @@ -1,9 +0,0 @@ -# Contributors - -Display | Name | Github Profile | Homepage ----|:---:|:---:|:---: -![](https://avatars0.githubusercontent.com/u/22460123?s=100) | Jeffry Lum | [Github](https://github.com/j-lum/) | [Homepage](https://se.kasugano.moe) -![](https://avatars0.githubusercontent.com/u/1673303?s=100) | Damith C. Rajapakse | [Github](https://github.com/damithc/) | [Homepage](https://www.comp.nus.edu.sg/~damithch/) -# I would like to join this list. How can I help the project - -For more information, please refer to our [contributor's guide](https://oss-generic.github.io/process/). diff --git a/README.md b/README.md index 8715d4d915..e39d7c74fc 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,35 @@ -# Duke 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. - -## Setting up in Intellij - -Prerequisites: JDK 11, update Intellij to the most recent version. - -1. Open Intellij (if you are not in the welcome screen, click `File` > `Close Project` to close the existing project first) -1. Open the project into Intellij as follows: - 1. Click `Open`. - 1. Select the project directory, and click `OK`. - 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/Duke.java` file, right-click it, and choose `Run Duke.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: - ``` - Hello from - ____ _ - | _ \ _ _| | _____ - | | | | | | | |/ / _ \ - | |_| | |_| | < __/ - |____/ \__,_|_|\_\___| - ``` +# User Guide +![Duke](docs/Ui.png) +## How to Start +1. Download the latest version of duke.jar [here](https://github.com/dreammac3816547290/ip/releases). +2. Open command prompt and navigate to the download folder. +3. Run `java -jar duke.jar`. +4. The Duke GUI will open, and you can type in commands in the command box. +## Command +### `bye` exits Duke +> bye +### `list` lists all tasks +> list +### `free` finds the nearest date without task +> free +### `mark` marks a task as done +`> mark ` +> mark 1 +### `unmark` marks a task as not done +`> unmark ` +> unmark 1 +### `find` finds all tasks which description matches a string +`> find ` +> find read book +### `todo` creates a todo task +`> todo ` +> todo read book at the library +### `deadline` creates a task with deadline +`> deadline /by ` +> deadline finish math homework /by 2022-09-19 +### `event` creates a task with time +`> event /at