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.

Sign up for GitHub

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

Branch documentation #191

Merged
merged 2 commits into from
Nov 13, 2023
Merged

Branch documentation #191

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab8e4be
Merge branch 'master' into branch-documentation
SinhaVedant Nov 13, 2023
e726fd2
Add How to use guide
SinhaVedant Nov 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/UserGuide.md
View file
Open in desktop
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
Loading