Skip to content

Commit 139d797

Browse files
authored
Merge pull request #13 from maze508/master
Update README and Add Ui Mockup
2 parents fbc547b + e8a5e5c commit 139d797

File tree

3 files changed

+21
-9
lines changed

3 files changed

+21
-9
lines changed

README.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,25 @@
33

44
![Ui](docs/images/Ui.png)
55

6-
* This is **a sample project for Software Engineering (SE) students**.<br>
7-
Example usages:
8-
* as a starting point of a course project (as opposed to writing everything from scratch)
9-
* as a case study
10-
* The project simulates an ongoing software project for a desktop application (called _AddressBook_) used for managing contact details.
6+
# Gourmet Grid
7+
8+
## Description
9+
10+
* The project simulates an ongoing software project for a desktop application (called _Gourmet Grid_) used for managing contact details.
1111
* It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big.
1212
* It comes with a **reasonable level of user and developer documentation**.
13-
* It is named `AddressBook Level 3` (`AB3` for short) because it was initially created as a part of a series of `AddressBook` projects (`Level 1`, `Level 2`, `Level 3` ...).
14-
* For the detailed documentation of this project, see the **[Address Book Product Website](https://se-education.org/addressbook-level3)**.
15-
* This project is a **part of the se-education.org** initiative. If you would like to contribute code to this project, see [se-education.org](https://se-education.org#https://se-education.org/#contributing) for more info.
13+
* It is named `Gourmet Grid` (`GG` for short)
14+
15+
## Main Features
16+
17+
#### List All Contacts
18+
>Format: `list`
19+
20+
#### Add New Contacts
21+
>Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]`
22+
23+
#### Delete Contacts
24+
>Format: `delete INDEX`
25+
26+
#### Search Contacts By Name
27+
>Format: `find n/NAME`

docs/DeveloperGuide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
pageNav: 3
55
---
66

7-
# AB-3 Developer Guide
7+
# Gourmet Grid
88

99
<!-- * Table of Contents -->
1010
<page-nav-print />

docs/images/Ui.png

159 KB
Loading

0 commit comments

Comments
 (0)