Skip to content

Commit c6dafb8

Browse files
Updated AboutUs, ContactUs, Readme (nus-cs2103-AY1920S2#45)
* update AboutUs * update AboutUs * update ContactUs * update readme * Fix checkstyle violations Co-authored-by: Nicholas Cristian Fernando <[email protected]>
1 parent 461a67b commit c6dafb8

File tree

6 files changed

+28
-32
lines changed

6 files changed

+28
-32
lines changed

README.adoc

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
= Address Book (Level 3)
1+
= Inventory Manager
22
ifdef::env-github,env-browser[:relfileprefix: docs/]
33

44
https://travis-ci.org/se-edu/addressbook-level3[image:https://travis-ci.org/se-edu/addressbook-level3.svg?branch=master[Build Status]]
@@ -14,9 +14,15 @@ ifndef::env-github[]
1414
image::images/Ui.png[width="600"]
1515
endif::[]
1616

17-
* This is a desktop Address Book application. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
18-
* It is a Java sample application intended for students learning Software Engineering while using Java as the main programming language.
19-
* 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.
17+
* This is a desktop Inventory Manager application. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
18+
* It facilitates easily management of stocks, which includes:
19+
** warning when supplies are
20+
low
21+
** easy sourcing of suppliers for selected goods
22+
** expiry management
23+
** seamless updating of inventory upon procurement and sales transactions
24+
* This application is optimized for fast-typists. If you are comfortable with the keyboard,
25+
Inventory Manager will be a joy to use!
2026
2127
== Site Map
2228

@@ -31,5 +37,6 @@ endif::[]
3137
* Some parts of this sample application were inspired by the excellent http://code.makery.ch/library/javafx-8-tutorial/[Java FX tutorial] by
3238
_Marco Jakob_.
3339
* Libraries used: https://openjfx.io/[JavaFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/junit-team/junit5[JUnit5]
40+
* This project is an extension of AddressBook-Level3 project codebase created by https://se-education.org[SE-EDU initiative]
3441

3542
== Licence : link:LICENSE[MIT]

docs/AboutUs.adoc

Lines changed: 17 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -4,53 +4,42 @@
44
:imagesDir: images
55
:stylesDir: stylesheets
66

7-
AddressBook - Level 3 was developed by the https://se-edu.github.io/docs/Team.html[se-edu] team. +
8-
_{The dummy content given below serves as a placeholder to be used by future forks of the project.}_ +
9-
{empty} +
107
We are a team based in the http://www.comp.nus.edu.sg[School of Computing, National University of Singapore].
118

129
== Project Team
1310

14-
=== John Doe
15-
image::damithc.jpg[width="150", align="left"]
16-
{empty}[http://www.comp.nus.edu.sg/~damithch[homepage]] [https://github.com/damithc[github]] [<<johndoe#, portfolio>>]
11+
=== Nicholas Cristian Fernando
12+
image::nicholascf.png[width="150", align="left"]
13+
{empty}[https://github.com/NicholasCF[github]] [<<johndoe#, portfolio>>]
1714

18-
Role: Project Advisor
19-
20-
'''
21-
22-
=== John Roe
23-
image::lejolly.jpg[width="150", align="left"]
24-
{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
25-
26-
Role: Team Lead +
27-
Responsibilities: UI
15+
Role: Developer +
16+
Responsibilities: Suppliers
2817

2918
'''
3019

31-
=== Johnny Doe
32-
image::yijinl.jpg[width="150", align="left"]
33-
{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
20+
=== Pang Jia Da
21+
image::pangjiada.png[width="150", align="left"]
22+
{empty}[https://github.com/PangJiaDa[github]] [<<johndoe#, portfolio>>]
3423

3524
Role: Developer +
36-
Responsibilities: Data
25+
Responsibilities: Transactions
3726

3827
'''
3928

40-
=== Johnny Roe
41-
image::m133225.jpg[width="150", align="left"]
42-
{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
29+
=== Fang Shao Hua
30+
image::fangshaohua94.png[width="150", align="left"]
31+
{empty}[https://github.com/FangShaoHua94[github]] [<<johndoe#, portfolio>>]
4332

4433
Role: Developer +
45-
Responsibilities: Dev Ops + Threading
34+
Responsibilities: Inventory
4635

4736
'''
4837

49-
=== Benson Meier
50-
image::yl_coder.jpg[width="150", align="left"]
51-
{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
38+
=== Liu Chao
39+
image::liuchao93.png[width="150", align="left"]
40+
{empty}[https://github.com/LiuChao93[github]] [<<johndoe#, portfolio>>]
5241

5342
Role: Developer +
54-
Responsibilities: UI
43+
Responsibilities: Suppliers
5544

5645
'''

docs/images/fangshaohua94.png

44.6 KB
Loading

docs/images/liuchao93.png

36.7 KB
Loading

docs/images/nicholascf.png

33.1 KB
Loading

docs/images/pangjiada.png

8.79 KB
Loading

0 commit comments

Comments
 (0)