From e726fd2ac8c7acdf822260d37662965c35cee427 Mon Sep 17 00:00:00 2001 From: Vedant Sinha Date: Tue, 14 Nov 2023 01:09:18 +0800 Subject: [PATCH] Add How to use guide --- docs/UserGuide.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 899765f8de7..b4c903c6994 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -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)** @@ -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.