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

Jump to bottom

Updated "Getting Started" in User guide. #64

Merged
merged 3 commits into from Oct 3, 2019
Merged

Updated "Getting Started" in User guide. #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6c64ee0
Updated "Getting Started" in User guide.
junnbang Oct 3, 2019
48e6087
Merge branch 'master' of https://github.com/AY1920S1-CS2103T-F14-4/ma…
junnbang Oct 3, 2019
df64aa3
Update UserGuide.adoc
tysg Oct 3, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
39 changes: 20 additions & 19 deletions docs/UserGuide.adoc
View file
Open in desktop
Expand Up @@ -24,25 +24,26 @@ Since: `Jun 2016` Licence: `MIT`

Deliveria is a *desktop application* that allows a *delivery manager* to *manage and assign delivery tasks* efficiently. While it consists of a _Graphical User Interface_ (GUI) that is user-friendly, Deliveria is *optimized for those who prefer* to work with a _Command Line Interface_ (CLI) which allows fast management of the delivery tasks in an organisation.

== Quick Start

. Ensure you have Java `11` or above installed in your Computer.
. Download the latest `addressbook.jar` link:{repoURL}/releases[here].
. Copy the file to the folder you want to use as the home folder for your Address Book.
. Double-click the file to start the app. The GUI should appear in a few seconds.
+
image::Ui.png[width="790"]
+
. Type the command in the command box and press kbd:[Enter] to execute it. +
e.g. typing *`help`* and pressing kbd:[Enter] will open the help window.
. Some example commands you can try:

* *`list`* : lists all contacts
* **`add`**`n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : adds a contact named `John Doe` to the Address Book.
* **`delete`**`3` : deletes the 3rd contact shown in the current list
* *`exit`* : exits the app

. Refer to <<Features>> for details of each command.
== Getting Started
.Draft UI mockup
image::/images/Ui.png[Ui]
[caption="Figure 1: ",link="/images/Ui.png"]
. Ensure you have Java 11 or above installed in your Computer.
. Download the latest release deliveria.jar https://github.com/AY1920S1-CS2103T-F14-4/main/releases[here].
. Copy the file to the folder you want to use as the home folder for your Address Book.
. Double-click the file to start the app. The GUI should appear in a few seconds.
. Type the command in the command box and press Enter to execute it.
e.g. typing help and pressing Enter will open the help window.
. Some example commands you can try
* Lists all contacts: `list`

* Adds a contact named John Doe to the Address Book: `Add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01`

* Deletes the 3rd contact shown in the current list: `Delete 3`

* Exits the app: `exit`

. Refer to <<Features>> for details of each command.

[[Features]]
== Features
Expand Down
Binary file modified docs/images/Ui.png
View file
Open in desktop
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.