UserGuide.adoc

EatMe User Guide

By: Team AY1920S1-CS2103T-W11-3 Since: September 2019 Licence: MIT

• 1. Introduction
• 2. About
• 3. Quick Start
• 4. Features
  • 4.1. General
  • 4.2. Working with eateries
  • 4.3. Import/Export
  • 4.4. Visualisation
  • 4.5. Todo
  • 4.6. News Feed
• 5. Quick Reference
• 6. FAQ

1. Introduction

EatMe is a food diary app for people who love good food. It will help you manage places you have been to, keep track of your experience and expenditure, and even keep you up-to-date with the latest food trends and events!

EatMe is optimized for those who like the speed of a Command Line Interface (CLI) while still maintaining the user-friendliness of a Graphical User Interface (GUI). Interested to keep track of your favorite food places with maximum efficiency? Try EatMe today! Jump to the Section 3, “Quick Start” to get started.

2. About

This user guide shows you how to use the features in EatMe. The commands that can be executed are explained in detail, and sample commands are provided for ease of understanding.

The following are some terms used in this document:

Command Line Interface (CLI)	A means of interacting with a computer program where the user issues commands to the program in the form of successive lines of text.
Graphical User Interface (GUI)	A means of interacting with a computer program through graphical icons and visual indicators.
add	Text in this font (called monospaced font) indicates that this is a command that can be typed into the command line and executed by the application.

3. Quick Start

1. Ensure you have Java 11 or above installed on your computer. If not, you can download it here.

2. Download the latest release of EatMe here.

3. Copy the file to the folder you want to use as the home folder for EatMe.

4. Double-click the file to start the app. The app should appear in a few seconds.

1. Type a command in the command box and press Enter to execute it.
   e.g. typing help and pressing Enter will open the help window.

2. Some example commands you can try:

   • add \n Two Chefs Eating Place \a 116 Commonwealth Cres, #01-129 \c Chinese : Adds an eatery named Two Chefs Eating Place with the specified address and category.

   • review \n Two Chefs Eating Place \d Nice Condensed Milk Pork Ribs \p 15 \r 4 \w 23/10/2019 : Adds a review to Two Chefs Eating Place with the specified description, price, rating and date.

   • random : Shows a random eatery - Useful if you can’t decide what to eat!

   • exit : Exits the app.

These are just a few of the commands you can execute on EatMe. Refer to Section 4, “Features” for the full list of available commands and their details.

4. Features

Command Format

• Items in square brackets are the parameters to be supplied by the user. For example, in add \n [name of eatery], [name of eatery] is a parameter which can be used as add n\ Two Chefs Eating Place.

• Items in curly brackets are optional parameters. For example, in add \n [name of eatery] \a [address] \c [category] {\t [tags, space-delimited]}, {\t [tags, space-delimited]} is an optional parameter that the user can choose to supply if he/she wishes to add certain tags to the eatery.

• Parameters can be in any order. For example, if the command specifies \n [name of eatery] \a [address] \c [category], \a [address] \n [name of eatery] \c [category] is also acceptable.

4.1. General

4.1.1. Viewing help: help

Format: help

4.1.2. Exit the app: exit

Format: exit

4.2. Working with eateries

4.2.1. Adding an eatery: add

Adds an eatery to the app.
Format: add \n [name of eatery] \a [address] \c [category] {\t [tags, space-delimited]}

Examples:

• add \n Two Chefs Eating Place \a 116 Commonwealth Cres, #01-129 \c Chinese

• add \n Two Chefs Eating Place \a 116 Commonwealth Cres, #01-129 \c Chinese \t good-for-groups non-aircon

4.2.2. Finding an eatery: find

Finds an eatery based on name or tag.
Format: find \n [name of eatery] or find \t [tag]

Examples:

• find \n Two Chefs Eating Place

• find \t Chinese

4.2.3. Changing address of an eatery: changeaddress

Changes the address of an eatery.
Format: changeaddress [id] \a [new address]

Examples:

• changeaddress 2 \a 116 Commonwealth Cres, #01-130

4.2.4. Marking an eatery as closed: close

Closes an eatery if the eatery is no longer there. The eatery will still be listed, but will be grayed out to inform you that the eatery no longer exists. In the case that you accidentally closed the wrong eatery or the eatery reopens, typing reopen does the opposite of close.
Format: close [id]

Examples:

• close 2

4.2.5. Reopening a closed eatery: reopen

Reopens a previously closed eatery.
Format: reopen [id]

Examples:

• reopen 2

4.2.6. Reviewing an eatery: review

Leaves a review for an eatery.
Format: review [id] \d [description] \p [price per person] \r [rating] \w [date in DD/MM/YYYY format]

Examples:

• review 2 \d Nice Condensed Milk Pork Ribs \p 15 \r 4 \w 23/10/2019

4.2.7. Tagging an eatery: addtag

Adds tags to an eatery.
Format: addtag [id] \t [tags, space-delimited]

Examples:

• addtag 2 \t hawker good-for-sharing

4.2.8. Removing tags from an eatery: removetag

Removes tags from an eatery.
Format: removetag [id] \t [tags, space-delimited]

Examples:

• removetag 2 \t hawker

4.2.9. Listing all eateries: list

Shows a list of all eateries in the app.
Format: list

4.2.10. Getting a random eatery: random

Shows a completely random restaurant - Useful in case you cannot decide what to eat!
Format: random

4.2.11. Viewing an eatery: show

Shows an eatery with all its details - Address, category, tags, reviews, external reviews and a map of its location.
Format: show [id]

Examples:

• show 2

4.3. Import/Export

4.3.1. Importing eateries: import

Imports eateries from a text file.
Format: import \f [filename]

Examples:

• import \f /home/user/eatme-backup-john.txt

4.3.2. Exporting eateries: export

Exports eateries to a text file.
Format: export \f [filename]

Examples:

• export \f /home/user/eatme-backup-john.txt

4.4. Visualisation

4.4.1. Showing overall statistics: stats

Presents a visual overview of the user’s eateries and reviews.
Format: stats

4.5. Todo

4.5.1. Toggling between main and todo modes: mode

Toggles between main and todo modes.
Format: mode

4.5.2. Adding a new todo eatery: addtodo

Adds a new eatery to the todo list.
Format: addtodo \n [name of eatery] \a [address] {\t [tags, space-delimited]}

Examples:

• addtodo \n Two Chefs Eating Place \a 116 Commonwealth Cres, #01-129 \t must-try

4.5.3. Deleting a todo eatery: deletetodo

Deletes an eatery from the todo list.
Format: deletetodo [id]

Examples:

• deletetodo 2

4.5.4. Marking a todo eatery as visited with optional saving : visited

Marks a todo eatery as visited and provides a quick way to add it to the main list of eateries.
Format: visited [id] or visited [id] \s (saves the eatery to the main list)

Examples:

• visited 2

• visited 2 \s

4.6. News Feed

4.6.1. Adding a feed : addfeed

Adds a feed to the news feed.
Format: addfeed \n [name of feed] \a [address of the RSS feed]

Examples:

• addfeed \n [Eatbook] \a https://eatbook.com/feed

4.6.2. Deleting a feed : deletefeed

Deletes a feed from the news feed.
Format: deletefeed \n [name of feed]

Examples:

• deletefeed \n Eatbook

5. Quick Reference

Type this…​	For this…​
help	Viewing help
exit	Exiting the app
add	Adding an eatery
find	Finding an eatery
changeaddress	Changing address of an eatery
close	Marking an eatery as closed
reopen	Reopening a closed eatery
review	Reviewing an eatery
addtag	Tagging an eatery
removetag	Removing tags from an eatery
list	Listing all eateries
random	Getting a random eatery
show	Viewing an eatery
import	Importing eateries
export	Exporting eateries
stats	Showing overall statistics
mode	Toggling between main and todo modes
addtodo	Adding a todo eatery
deletetodo	Deleting a todo eatery
visited	Marking a todo eatery as visited with optional saving
addfeed	Adding a feed
deletefeed	Deleting a feed

6. FAQ

Q: How do I transfer my data to another Computer?
A: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous EatMe folder.