[CS2103T-T17-2] Traveez

.travis.yml

@@ -1,24 +1,24 @@
-language: java
-matrix:
-  include:
-    - jdk: openjdk11
-
-script: >-
-    ./config/travis/run-checks.sh &&
-    ./gradlew clean checkstyleMain checkstyleTest test coverage coveralls asciidoctor
-
-deploy:
-  skip_cleanup: true
-  provider: script
-  script: ./config/travis/deploy_github_pages.sh
-  on:
-    branch: master
-
-before_cache:
-  - rm -f  $HOME/.gradle/caches/modules-2/modules-2.lock
-  - rm -fr $HOME/.gradle/caches/*/plugin-resolution/
-
-cache:
-  directories:
-    - $HOME/.gradle/caches/
-    - $HOME/.gradle/wrapper/
+language: java
+matrix:
+  include:
+    - jdk: openjdk11
+
+script: >-
+    ./gradlew clean test coverage coveralls asciidoctor
+
+
+deploy:
+  skip_cleanup: true
+  provider: script
+  script: ./config/travis/deploy_github_pages.sh
+  on:
+    branch: master
+
+before_cache:
+  - rm -f  $HOME/.gradle/caches/modules-2/modules-2.lock
+  - rm -fr $HOME/.gradle/caches/*/plugin-resolution/
+
+cache:
+  directories:
+    - $HOME/.gradle/caches/
+    - $HOME/.gradle/wrapper/

README.adoc

@@ -1,36 +1,39 @@
-= Address Book (Level 3)
-ifdef::env-github,env-browser[:relfileprefix: docs/]
-
-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]]
-https://gitter.im/se-edu/Lobby[image:https://badges.gitter.im/se-edu/Lobby.svg[Gitter chat]]
-
-ifdef::env-github[]
-image::docs/images/Ui.png[width="600"]
-endif::[]
-
-ifndef::env-github[]
-image::images/Ui.png[width="600"]
-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.
-
-== 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]
-
-== Licence : link:LICENSE[MIT]
+= TravEzy
+ifdef::env-github,env-browser[:relfileprefix: docs/]
+
+https://travis-ci.org/AY1920S1-CS2103T-T17-2/main[image:https://travis-ci.org/AY1920S1-CS2103T-T17-2/main.svg?branch=master[Build Status]]
+
+ifdef::env-github[]
+image::docs/images/Ui.png[width="600"]
+endif::[]
+
+ifndef::env-github[]
+image::images/Ui.png[width="600"]
+endif::[]
+
+Hey you! Yes you! Do you like travelling around the world but find it hard to manage your expenses while travelling abroad?
+Well then we just have the solution for you. Introducing Travezy, with Travezy, we help NUS students who love travelling plan their
+travel plans while keeping a lookout of their expenditure throughout the time. Travezy is your one stop trusty desktop
+application to organize your plans and financial needs. But wait, there's more, Travezy is optimized for those who prefer
+to work with a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can
+type fast this is definitely the app for you! So what are you waiting for? Get your copy of Travezy today!
+
+== Site Map
+
+* <<UserGuide#, User Guide>>
+* <<DeveloperGuide#, Developer Guide>>
+* <<LearningOutcomes#, Learning Outcomes>>
+* <<AboutUs#, About Us>>
+* <<ContactUs#, Contact Us>>
+
+== Acknowledgements
+
+* The original source code is obtained from AddressBook-Level3 project by https://se-education.org[SE-EDU]
+* 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_.
+* Travezy would like to acknowledge the following awesome source code and guidance in creating this application.
+AddressBook-Level3 project created by SE-EDU initiative at https://se-education.org
+* UI is designed with the use of Flaticons
+* Libraries used: https://openjfx.io/[JavaFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/junit-team/junit5[JUnit5]
+
+== Licence : link:LICENSE[MIT]