diff --git a/.gitignore b/.gitignore index 99712178bf..06aec6b62d 100644 --- a/.gitignore +++ b/.gitignore @@ -12,3 +12,10 @@ src/main/resources/docs/ .DS_Store *.iml bin/ + +#data files from program +/data.txt/ +data.txt +/recurringData.txt/ +recurringData.txt +/overdue.txt diff --git a/README.md b/README.md index 84755485a7..11e480cd01 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,18 @@ -# Setting up +# ROOMSHARE - Your friendly personal assistant -**Prerequisites** +--- +## Introduction -* JDK 11 -* Recommended: IntelliJ IDE -* Fork this repo to your GitHub account and clone the fork to your computer +* RoomShare is personal assistant software in the form of Command Line Interface (CLI). It is designed for you to keep track of your daily tasks and other people sharing your house or apartment. With RoomShare, your can group your tasks into different categories, assign their priorities, mark tasks to be informed to your housemates and many other functions. -**Importing the project into IntelliJ** +![](https://github.com/AY1920S1-CS2113T-F14-3/main/blob/master/RoomShareUI.png) -1. Open IntelliJ (if you are not in the welcome screen, click `File` > `Close Project` to close the existing project dialog first). -1. Set up the correct JDK version. - * Click `Configure` > `Structure for new Projects` (in older versions of Intellij:`Configure` > `Project Defaults` > `Project Structure`). - * If JDK 11 is listed in the drop down, select it. If it is not, click `New...` and select the directory where you installed JDK 11. - * Click `OK`. -1. Click `Import Project`. -1. Locate the project directory and click `OK`. -1. Select `Create project from existing sources` and click `Next`. -1. Rename the project if you want. Click `Next`. -1. Ensure that your src folder is checked. Keep clicking `Next`. -1. Click `Finish`. +## Features +* Roomshare allows you to add tasks into a task list, and track their progress. +* Supports adding and deleting tasks +* RoomShare will also help to check if some of your time sensitive tasks have overlap, to prevent you from scheduling clashing events +* Look for tasks with the in built search +* Once you're done with the task, just mark it as done! +* Also supports recurring tasks, so you won't need to manually add the same tasks everytime! -# Tutorials - -Duke Increment | Tutorial ----------------|--------------- -`A-Gradle` | [Gradle Tutorial](tutorials/gradleTutorial.md) -`A-TextUiTesting` | [Text UI Testing Tutorial](tutorials/textUiTestingTutorial.md) -`Level-10` | JavaFX tutorials:
→ [Part 1: Introduction to JavaFX][fx1]
→ [Part 2: Creating a GUI for Duke][fx2]
→ [Part 3: Interacting with the user][fx3]
→ [Part 4: Introduction to FXML][fx4] - -[fx1]: -[fx2]: -[fx3]: -[fx4]: - -# 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). -* We welcome pull requests too. \ No newline at end of file +## Roomshare helps you to organise your tasks, so you can keep your mind on things that matter more! diff --git a/RoomShare.ipr b/RoomShare.ipr new file mode 100644 index 0000000000..69b86d38ce --- /dev/null +++ b/RoomShare.ipr @@ -0,0 +1,68 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 11 + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/RoomShare.iws b/RoomShare.iws new file mode 100644 index 0000000000..76dd966376 --- /dev/null +++ b/RoomShare.iws @@ -0,0 +1,149 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 1572320628790 + + + + + + + + + + + file://$PROJECT_DIR$/src/test/java/TaskListTest.java + 38 + + + + + file://$PROJECT_DIR$/src/test/java/TaskListTest.java + 92 + + + + + file://$PROJECT_DIR$/src/test/java/TaskListTest.java + 106 + + + + + \ No newline at end of file diff --git a/RoomShareUI.png b/RoomShareUI.png new file mode 100644 index 0000000000..b6c0251828 Binary files /dev/null and b/RoomShareUI.png differ diff --git a/TeamProject.ipr b/TeamProject.ipr new file mode 100644 index 0000000000..251dfac868 --- /dev/null +++ b/TeamProject.ipr @@ -0,0 +1,160 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 11 + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/TeamProject.iws b/TeamProject.iws new file mode 100644 index 0000000000..b30b951c46 --- /dev/null +++ b/TeamProject.iws @@ -0,0 +1,173 @@ + + + + + + + + + + + + + + + + +