[CS2103T-W16-3] StudyBuddy

.travis.yml

@@ -4,8 +4,8 @@ matrix:
     - jdk: openjdk11
 
 script: >-
-    ./config/travis/run-checks.sh &&
-    ./gradlew clean checkstyleMain checkstyleTest test coverage coveralls asciidoctor
+  ./config/travis/run-checks.sh &&
+  ./gradlew clean checkstyleMain checkstyleTest test coverage coveralls asciidoctor
 
 deploy:
   skip_cleanup: true

README.adoc

@@ -1,36 +1,56 @@
-= Address Book (Level 3)
-ifdef::env-github,env-browser[:relfileprefix: docs/]
+= Study Buddy
+=======
+
+== Introduction
 
-https://travis-ci.org/se-edu/addressbook-level3[image:https://travis-ci.org/se-edu/addressbook-level3.svg?branch=master[Build Status]]
-https://ci.appveyor.com/project/damithc/addressbook-level3[image:https://ci.appveyor.com/api/projects/status/3boko2x2vr5cc3w2?svg=true[Build status]]
-https://coveralls.io/github/se-edu/addressbook-level3?branch=master[image:https://coveralls.io/repos/github/se-edu/addressbook-level3/badge.svg?branch=master[Coverage Status]]
-https://www.codacy.com/app/damith/addressbook-level3?utm_source=github.com&utm_medium=referral&utm_content=se-edu/addressbook-level3&utm_campaign=Badge_Grade[image:https://api.codacy.com/project/badge/Grade/fc0b7775cf7f4fdeaf08776f3d8e364a[Codacy Badge]]
+ifdef::env-github,env-browser[:relfileprefix: docs/]
 
+https://travis-ci.org/AY1920S2-CS2103T-W16-3/main[image:https://travis-ci.org/AY1920S2-CS2103T-W16-3/main.svg?branch=master[Build Status]]
+https://coveralls.io/github/AY1920S2-CS2103T-W16-3/main?branch=master[image:https://coveralls.io/repos/github/AY1920S2-CS2103T-W16-3/main/badge.svg?branch=master&service=github[Coverage Status]]
+https://ci.appveyor.com/project/teikjun/main-obe5y/branch/master[image:https://ci.appveyor.com/api/projects/status/01kv1ged83vovfi3/branch/master?svg=true[Build status]]
+https://www.codacy.com/gh/AY1920S2-CS2103T-W16-3/main?utm_source=github.com&utm_medium=referral&utm_content=AY1920S2-CS2103T-W16-3/main&utm_campaign=Badge_Grade[image:https://api.codacy.com/project/badge/Grade/8ff09067ff534489afad2264bade805a[Codacy Badge]]
 
 ifdef::env-github[]
 image::docs/images/Ui.png[width="600"]
 endif::[]
 
 ifndef::env-github[]
-image::images/Ui.png[width="600"]
+image::images/Ui.png[width="600",title="UI Sample Picture, will be updated in ther future"]
 endif::[]
 
-* This is a desktop Address Book application. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
-* It is a Java sample application intended for students learning Software Engineering while using Java as the main programming language.
-* It is *written in OOP fashion*. It provides a *reasonably well-written* code example that is *significantly bigger* (around 6 KLoC)than what students usually write in beginner-level SE modules.
+=== What is Study Buddy ?
+
+* Study Buddy is a task management tool for students who wish to organise their tasks more efficiently.
+* With the help of Study Buddy, students can easily view and manage their module related tasks.
+* Sort, filter and search commands are also provided to make the interaction more useful.
+* It also provides services to show the statistics for time, grades breakdown and workload comparison between different modules in Pie charts.
+This visualisation of data helps students become more aware of their Pending work and which tasks to spend more time on.
+
+=== Who can benefit most from Study Buddy?
+
+=======
+* It is designed for students who can type fast and are comfortable with `Command-Line Interface(CLI)`.
+=======
+
+=== What is CLI?
+
+* CLI is a command line program that accepts text input to execute operating system functions.
+* Compare with graphical user interfaces(GUI), CLI performs interaction with user by keyboard input instead of mouse clicking, such as command window.
 
 == Site Map
 
+To browse more information, please check our site map:
+
 * <<UserGuide#, User Guide>>
 * <<DeveloperGuide#, Developer Guide>>
-* <<LearningOutcomes#, Learning Outcomes>>
 * <<AboutUs#, About Us>>
 * <<ContactUs#, Contact Us>>
 
 == Acknowledgements
 
-* Some parts of this sample application were inspired by the excellent http://code.makery.ch/library/javafx-8-tutorial/[Java FX tutorial] by
-_Marco Jakob_.
-* Libraries used: https://openjfx.io/[JavaFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/junit-team/junit5[JUnit5]
+* Some parts of this application were inspired by the excellent
+http://code.makery.ch/library/javafx-8-tutorial/[Java FX tutorial] by _Marco Jakob_.
+* Libraries used: https://openjfx.io/[JavaFX],
+https://github.com/FasterXML/jackson[Jackson], https://github.com/junit-team/junit5[JUnit5]
+* AddressBook-Level3 project created by SE-EDU initiative at https://se-education.org
 
-== Licence : link:LICENSE[MIT]