Skip to content

Commit

Permalink
Add How to use guide
Browse files Browse the repository at this point in the history
  • Loading branch information
SinhaVedant committed Nov 13, 2023
1 parent ab8e4be commit e726fd2
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ type fast, ModuLight can get your student grading tasks done faster than traditi

--------------------------------------------------------------------------------------------------------------------
* Table of Contents
* **[How to use this guide](#how-to-use-this-guide)**
* **[Quick Start](#quick-start)**
* **[Parameter Information](#parameter-information)**
* **[Navigating the Graphical User Interface (GUI)](#navigating-the-graphical-user-interface-gui)**
Expand All @@ -37,6 +38,25 @@ type fast, ModuLight can get your student grading tasks done faster than traditi

--------------------------------------------------------------------------------------------------------------------

## How to use this guide
1. For the first time users we recommend to:

* Start with the [Quick start](#quick-start) to download, setup and run the program.

* Go through [Navigating the Graphical User Interface (GUI)](#navigating-the-graphical-user-interface-gui)
section to understand the different components of the GUI of the program.

* Go through the [Command Format](#command-format) to get an idea of the correct way to understand and input the
commands.

2. For regular users:

* We have provided a [command summary](#command-summary) for you to check all the available features.

* More detailed explanation of the features can be found under the [Features](#features) section.
* An overview of all the parameters used in the commands along with their constraints and such can be found
under the [Parameter Information](#parameter-information) section.

## Quick start

1. Ensure you have Java `11` or above installed in your Computer.
Expand Down

0 comments on commit e726fd2

Please sign in to comment.