Skip to content

Commit

Permalink
Merge pull request nus-cs2103-AY1718S2#39 from Kyomian/master
Browse files Browse the repository at this point in the history
Change README, AboutUs, target user, and name of app
  • Loading branch information
Kyomian authored Mar 13, 2018
2 parents 36c4ce6 + af16e16 commit bcc4a6f
Show file tree
Hide file tree
Showing 4 changed files with 86 additions and 97 deletions.
17 changes: 6 additions & 11 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Task Manager
= CLIndar
ifdef::env-github,env-browser[:relfileprefix: docs/]

https://travis-ci.org/CS2103JAN2018-W13-B3/main[image:https://travis-ci.org/CS2103JAN2018-W13-B3/main.svg?branch=master[Build Status]]
Expand All @@ -8,31 +8,26 @@ https://www.codacy.com/app/damith/addressbook-level4?utm_source=github.com&utm_m
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"]
image on hold
endif::[]

ifndef::env-github[]
image::images/Ui.png[width="600"]
image on hold
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.
* CLindar is a desktop application that helps university computing students to manage their tasks and events.
* It is a GUI app but most of its user interaction is CLI (Command Line Interface)-based, which computing students are familiar with.
== Site Map

* <<UserGuide#, User Guide>>
* <<DeveloperGuide#, Developer Guide>>
* <<LearningOutcomes#, Learning Outcomes>>
* <<AboutUs#, About Us>>
* <<ContactUs#, Contact Us>>

== Acknowledgements

* This app was based on Addressbook - Level 4, developed by the https://github.com/se-edu/[se-edu] team.
* 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]
Expand Down
46 changes: 20 additions & 26 deletions docs/AboutUs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,53 +3,47 @@
:imagesDir: images
:stylesDir: stylesheets

AddressBook - Level 4 was developed by the https://se-edu.github.io/docs/Team.html[se-edu] team. +
CLIndar was developed by the CS2103JAN2018-W13-B3 team. +
_{The dummy content given below serves as a placeholder to be used by future forks of the project.}_ +
{empty} +
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>>]
=== Jarrett Choo

Role: Project Advisor
{empty}[https://github.com/Kyomian[github]]

Role: To Be Confirmed
Responsibilities: Logic

'''

=== John Roe
image::lejolly.jpg[width="150", align="left"]
{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
=== Jasmond Toh

{empty}[http://github.com/jasmoon[github]]

Role: Team Lead +
Role: To Be Confirmed
Responsibilities: UI

'''

=== Johnny Doe
image::yijinl.jpg[width="150", align="left"]
{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
=== Karen Frilya

Role: Developer +
Responsibilities: Data
{empty}[http://github.com/karenfrilya97[github]]

Role: To Be Confirmed
Responsibilities: Storage

'''

=== Johnny Roe
image::m133225.jpg[width="150", align="left"]
{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
=== Yuan Quan

Role: Developer +
Responsibilities: Dev Ops + Threading
{empty}[http://github.com/YuanQQLer[github]]

'''
Role: To Be Confirmed
Responsibilities: Model

=== Benson Meier
image::yl_coder.jpg[width="150", align="left"]
{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
'''

Role: Developer +
Responsibilities: UI

'''
Loading

0 comments on commit bcc4a6f

Please sign in to comment.