Skip to content

Commit

Permalink
Merge pull request #4 from chrisjwelly/update-readme
Browse files Browse the repository at this point in the history
Update README and Website Headings
  • Loading branch information
chrisjwelly authored Mar 4, 2020
2 parents e5e3415 + 2060e19 commit 9223afe
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 12 deletions.
10 changes: 4 additions & 6 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
= Address Book (Level 3)
= ResuMe
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://travis-ci.com/AY1920S2-CS2103T-F10-1/main[image:https://travis-ci.com/AY1920S2-CS2103T-F10-1/main.svg?branch=master[Build Status]]
https://coveralls.io/github/AY1920S2-CS2103T-F10-1/main?branch=master[image:https://coveralls.io/repos/github/AY1920S2-CS2103T-F10-1/main/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[]
Expand All @@ -15,15 +13,14 @@ 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).
* This is a desktop Resume management 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>>

Expand All @@ -32,6 +29,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://openjfx.io/[JavaFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/junit-team/junit5[JUnit5]
* The starting point of this code is AddressBook-Level3 project created by https://se-education.org[SE-EDU initiative]

== Licence : link:LICENSE[MIT]

Expand Down
2 changes: 1 addition & 1 deletion docs/DevOps.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= AddressBook Level 3 - Dev Ops
= ResuMe - Dev Ops
:site-section: DeveloperGuide
:toc:
:toc-title:
Expand Down
2 changes: 1 addition & 1 deletion docs/DeveloperGuide.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= AddressBook Level 3 - Developer Guide
= ResuMe - Developer Guide
:site-section: DeveloperGuide
:toc:
:toc-title:
Expand Down
2 changes: 1 addition & 1 deletion docs/Documentation.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= AddressBook Level 3 - Documentation
= ResuMe - Documentation
:site-section: DeveloperGuide
:toc:
:toc-title:
Expand Down
2 changes: 1 addition & 1 deletion docs/SettingUp.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= AddressBook Level 3 - Setting Up
= ResuMe - Setting Up
:site-section: DeveloperGuide
:toc:
:toc-title:
Expand Down
2 changes: 1 addition & 1 deletion docs/Testing.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= AddressBook Level 3 - Testing
= ResuMe - Testing
:site-section: DeveloperGuide
:toc:
:toc-title:
Expand Down
2 changes: 1 addition & 1 deletion docs/UserGuide.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= AddressBook Level 3 - User Guide
= ResuMe - User Guide
:site-section: UserGuide
:toc:
:toc-title:
Expand Down

0 comments on commit 9223afe

Please sign in to comment.