nus-cs2103-AY1718S2 · laichengyu · Mar 8, 2018 · Mar 8, 2018 · Mar 8, 2018 · Mar 8, 2018
diff --git a/README.adoc b/README.adoc
@@ -1,11 +1,9 @@
 = Address Book (Level 4)
 ifdef::env-github,env-browser[:relfileprefix: docs/]
 
-https://travis-ci.org/se-edu/addressbook-level4[image:https://travis-ci.org/se-edu/addressbook-level4.svg?branch=master[Build Status]]
-https://ci.appveyor.com/project/damithc/addressbook-level4[image:https://ci.appveyor.com/api/projects/status/3boko2x2vr5cc3w2?svg=true[Build status]]
-https://coveralls.io/github/se-edu/addressbook-level4?branch=master[image:https://coveralls.io/repos/github/se-edu/addressbook-level4/badge.svg?branch=master[Coverage Status]]
-https://www.codacy.com/app/damith/addressbook-level4?utm_source=github.com&utm_medium=referral&utm_content=se-edu/addressbook-level4&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]]
+https://travis-ci.org/CS2103JAN2018-F09-B3/main[image:https://travis-ci.org/CS2103JAN2018-F09-B3/main.svg?branch=master[Build Status]]
+https://ci.appveyor.com/project/ewaldhew/main[image:https://ci.appveyor.com/api/projects/status/anm4ynat6657reac?svg=true[Build Status]]
+https://coveralls.io/github/CS2103JAN2018-F09-B3/main?branch=master[image:https://coveralls.io/repos/github/CS2103JAN2018-F09-B3/main/badge.svg?branch=master[Coverage Status]]
 
 ifdef::env-github[]
 image::docs/images/Ui.png[width="600"]
@@ -15,24 +13,40 @@ 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.
-* What's different from https://github.com/se-edu/addressbook-level3[level 3]:
-** A more sophisticated GUI that includes a list  panel and an in-built Browser.
-** More test cases, including automated GUI testing.
-** Support for _Build Automation_ using Gradle and for _Continuous Integration_ using Travis CI.
+** This is a desktop Crypto Currency management portfolio called CoinBook
+
+** Meant for storing and keeping track of one’s cryptocurrency records
+
+** Has a GUI but most of the user interactions happen using CLI (Command Line Interface)
+
+** Java application  targeted at businessmen or investors who trade heavily and actively in cryptocurrency coins
+
+** Helps user to keep track of trades for multiple coins; useful for frequent trading
+
+** Provides decision making stats to equip user with the information necessary to trade
+
+** User won't have to check patterns and statistics on another platform other than the CoinBook
+
+** Displays price history of coin --> Allows user to see price changes over time
+
+** View current price of crypto coin (based on 24 hour average) and the profit/loss the user stands to make if he sold the coin at the current moment
+
+** Various statistics to aid decision making such as Relative Strength Index(RSI) and Moving average convergence divergence (MACD) charts
+
+** Newsfeed for user to follow the news and happenings surrounding the coin
+
+** Allows the user to compare the price history based on newsfeed of any given coin.
 
 == Site Map
 
 * <<UserGuide#, User Guide>>
 * <<DeveloperGuide#, Developer Guide>>
-* <<LearningOutcomes#, Learning Outcomes>>
 * <<AboutUs#, About Us>>
 * <<ContactUs#, Contact Us>>
 
 == Acknowledgements
 
+* Based off the AddressBook-Level4 project, a software project for students learning Software Engineering with Java as the main programming language. Created by the SE-EDU initiative at https://github.com/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_.
 * Libraries used: https://github.com/TomasMikula/EasyBind[EasyBind], https://github.com/TestFX/TestFX[TextFX], https://bitbucket.org/controlsfx/controlsfx/[ControlsFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/google/guava[Guava], https://github.com/junit-team/junit4[JUnit4]

diff --git a/appveyor.yml b/appveyor.yml
@@ -5,7 +5,7 @@
 # --no-daemon: Prevent the daemon from launching to prevent file-in-use errors
 #     when we cache the ~/.gradle directory
 build_script:
-    - gradlew.bat --no-daemon assemble checkstyleMain checkstyleTest
+    - gradlew.bat --no-daemon fixWhitespace assemble checkstyleMain checkstyleTest
 
 test_script:
     - appveyor-retry gradlew.bat --no-daemon headless allTests

diff --git a/build.gradle b/build.gradle
@@ -26,6 +26,30 @@ repositories {
     maven { url "https://oss.sonatype.org/content/repositories/snapshots/" }
 }
 
+task makeTempFiles(type: Copy) {
+    from 'docs'
+    into 'temp'
+    include '**/*.adoc'
+    include '**/*.css'
+}
+
+task fixWhitespace(type: Copy) {
+    from 'temp'
+    into 'docs'
+    include '**/*.adoc'
+    include '**/*.css'
+    filter { String line ->
+        line.replaceAll(/ +$/, '')
+    }
+}
+
+task deleteTempFiles(type: Delete) {
+    delete 'temp'
+}
+
+fixWhitespace.dependsOn makeTempFiles
+fixWhitespace.finalizedBy deleteTempFiles
+
 checkstyle {
     toolVersion = '8.1'
 }

diff --git a/config/checkstyle/suppressions.xml b/config/checkstyle/suppressions.xml
@@ -6,4 +6,5 @@
 
 <suppressions>
   <suppress checks="JavadocType" files=".*Test\.java"/>
+  <suppress checks="MemberNameCheck" files="CryptoCompareHistoHourObject.java" />
 </suppressions>
diff --git a/config/travis/check-trailing-whitespace.sh b/config/travis/check-trailing-whitespace.sh
@@ -9,10 +9,10 @@ awk '
         ret = 0
     }
     {
-        # Only warn for markdown files (*.md) to accomodate text editors
+        # Only warn for asciidoc files (*.adoc) to accomodate text editors
         # which do not properly handle trailing whitespace.
         # (e.g. GitHub web editor)
-        if ($1 ~ /\.md$/) {
+        if ($1 ~ /\.adoc$/) {
             severity = "WARN"
         } else {
             severity = "ERROR"

diff --git a/docs/AboutUs.adoc b/docs/AboutUs.adoc
@@ -3,53 +3,45 @@
 :imagesDir: images
 :stylesDir: stylesheets
 
-AddressBook - Level 4 was developed by the https://se-edu.github.io/docs/Team.html[se-edu] team. +
-_{The dummy content given below serves as a placeholder to be used by future forks of the project.}_ +
-{empty} +
+CoinBook is developed by the CS2103JAN2018-F09-B3 team. This project is based off +
+AddressBook - Level 4, which was developed by the https://se-edu.github.io/docs/Team.html[se-edu] team.
+
 We are a team based in the http://www.comp.nus.edu.sg[School of Computing, National University of Singapore].
 
 == Project Team
 
-=== John Doe
-image::damithc.jpg[width="150", align="left"]
-{empty}[http://www.comp.nus.edu.sg/~damithch[homepage]] [https://github.com/damithc[github]] [<<johndoe#, portfolio>>]
+=== Eldon Chung
+image::eldon-chung.png[width="150", align="left"]
+{empty}[https://github.com/Eldon-Chung[github]] [<<eldon-chung#, portfolio>>]
 
-Role: Project Advisor
+Role: Developer +
+Responsibilities: Documentation, Logic
 
 '''
 
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
+=== Ewald Hew
+image::ewaldhew.png[width="150", align="left"]
+{empty}[http://github.com/ewaldhew[github]] [<<ewaldhew#, portfolio>>]
 
-Role: Team Lead +
+Role: Developer, Scheduling and tracking +
 Responsibilities: UI
 
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== Lai Cheng Yu
+image::laichengyu.png[width="150", align="left"]
+{empty}[http://github.com/laichengyu[github]] [<<laichengyu#, portfolio>>]
 
-Role: Developer +
-Responsibilities: Data
+Role: Developer, Code quality +
+Responsibilities: Integration
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== Neil Mehta
+image::neilish3re.png[width="150", align="left"]
+{empty}[http://github.com/neilish3re[github]] [<<neilish3re#, portfolio>>]
 
 Role: Developer +
-Responsibilities: Dev Ops + Threading
-
-'''
-
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
-
-Role: Developer +
-Responsibilities: UI
+Responsibilities: Model
 
 '''