Skip to content

Commit

Permalink
Merge ea96721 into 3c05f41
Browse files Browse the repository at this point in the history
  • Loading branch information
QzSG authored Sep 17, 2018
2 parents 3c05f41 + ea96721 commit 62c977f
Show file tree
Hide file tree
Showing 6 changed files with 326 additions and 125 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2016 Software Engineering Education - FOSS Resources
Copyright (c) 2016 Software Engineering Education - FOSS Resources, CS2113-AY1819S1-T13-1 <https://github.com/CS2113-AY1819S1-T13-1>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
21 changes: 10 additions & 11 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
= Address Book (Level 4)
= Student Planner
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]]

> Insert Marketing Blurb here


https://travis-ci.com/CS2113-AY1819S1-T13-1/main[image:https://travis-ci.com/CS2113-AY1819S1-T13-1/main.svg?branch=master[Build Status]]
https://ci.appveyor.com/project/QzSG/main[image:https://ci.appveyor.com/api/projects/status/g6ikkdmvc9v4mqop?svg=true[Build status]]
https://coveralls.io/github/CS2113-AY1819S1-T13-1/main?branch=master[image:https://coveralls.io/repos/github/CS2113-AY1819S1-T13-1/main/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]]

ifdef::env-github[]
image::docs/images/Ui.png[width="600"]
Expand All @@ -15,13 +18,8 @@ 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.
* This is a desktop Student Planner. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
* 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.
== Site Map

Expand All @@ -36,6 +34,7 @@ endif::[]
* 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/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/junit5[JUnit5]
* The awesome https://github.com/se-edu/addressbook-level4[Addressbook-Level4] used as the starting point of this amazing application

== Licence : link:LICENSE[MIT]

6 changes: 3 additions & 3 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -207,9 +207,9 @@ asciidoctor {
idprefix: '', // for compatibility with GitHub preview
idseparator: '-',
'site-root': "${sourceDir}", // must be the same as sourceDir, do not modify
'site-name': 'AddressBook-Level4',
'site-githuburl': 'https://github.com/se-edu/addressbook-level4',
'site-seedu': true, // delete this line if your project is not a fork (not a SE-EDU project)
'site-name': 'Student-Planner',
'site-githuburl': 'https://github.com/CS2113-AY1819S1-T13-1/main',
'site-seedu': false, // delete this line if your project is not a fork (not a SE-EDU project)
]

options['template_dirs'].each {
Expand Down
7 changes: 3 additions & 4 deletions docs/AboutUs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,12 @@
: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} +
Student Planner was developed by the https://cs2113-ay1819s1-t13-1.github.io/main/AboutUs.html[Student Planner] team. +
We are a team based in the http://www.comp.nus.edu.sg[School of Computing, National University of Singapore].

== Project Team

//Alphabetical order : AT, CSG, I , LH , MGGM ???
//Image naming format : [yourgithubusername].jpg Example: QzSG.jpg
=== 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>>]
Expand Down
Loading

0 comments on commit 62c977f

Please sign in to comment.