Skip to content

Commit

Permalink
Update CLI explanation in UG
Browse files Browse the repository at this point in the history
  • Loading branch information
gyulong1 committed Apr 14, 2023
1 parent 6a92c23 commit 7e36d6f
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,15 +113,21 @@ This will come in handy if:
This section displays relevant messages or errors after the command is entered.

#### 5. Command Line Interface (CLI)

<img src="images/UserGuide/CLI.png" class="centerImage">
In this section, you can enter your command in the text box and click enter on your keyboard to send it to the application.

This is also known as a Command Line Interface or CLI for short. If you are new to CLI, refer to the questions below for a quick crash course,

<u> What is CLI?</u>

To understand CLI better, here is an analogy:
Imagine being in a restaurant with a talented chef in the kitchen. The chef represents the computer while a waiter is a button on your screen. Instead of having to go through the waiter or "click" a button, the CLI helps you communicate directly with the chef by giving specific instructions or "orders" about what you want to eat. Hence, the CLI is a way to interact with your computer by giving precise, text-based instructions, much like talking directly to a chef to customize your meal.

<u> Why use CLI?</u>

Using a CLI can greatly enhance your efficiency as you no longer have to toggle between the mouse and your keyboard. Don't worry if this is your first time using the CLI, you'll get used to it in no time.

<img src="images/UserGuide/CLI.png" class="centerImage">
In this section, you can enter your commands in the text box and click enter on your keyboard to send in your command to the application.

--------------------------------------------------------------------------------------------------------------------
## Quick start
Expand Down

0 comments on commit 7e36d6f

Please sign in to comment.