Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README with Summary #29

Merged
merged 9 commits into from
Sep 22, 2020
Merged

Conversation

jiaweiteo
Copy link

No description provided.

@jiaweiteo jiaweiteo added this to the v1.1 milestone Sep 21, 2020
@jiaweiteo jiaweiteo added this to In progress in v1.1 via automation Sep 21, 2020
README.md Outdated
**Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake`
**List** | `list`
**Help** | `help`
We would like to acknowledge the original source of the code, AddressBook-Level3 project created by SE-EDU initiative at https://se-education.org
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it better to change this sentence to this?
"This project is based on the AddressBook-Level3 project created by the SE-EDU initiative."
As I feel like this flows better for me.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed

Copy link
Collaborator

@lyeyixian lyeyixian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have leave some comments (actually just one haha), please check.

README.md Outdated
@@ -3,176 +3,28 @@ layout: page
title: User Guide
---

AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB3 can get your contact management tasks done faster than traditional GUI apps.
[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be linked to our repo's actions instead of the se-edu's one?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ya but i dont know what badges we should add, there's quite a few different one

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no i mean the link not the badges. Now you are linking it to se-edu/addressbook-level3

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed

@lyeyixian lyeyixian merged commit b6b339f into AY2021S1-CS2103-T14-3:master Sep 22, 2020
v1.1 automation moved this from In progress to Done Sep 22, 2020
@lyeyixian lyeyixian linked an issue Sep 24, 2020 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
v1.1
  
Done
Development

Successfully merging this pull request may close these issues.

Update README.md to match our project
2 participants