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.

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

Update png in docs #137

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 16 additions & 8 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,32 +8,40 @@ with it using a CLI, and it has a GUI created with JavaFX.
<!-- * Table of Contents -->
<page-nav-print />

--------------------------------------------------------------------------------------------------------------------
## Table of Contents
* [Quick start](#quick-start)
* [Features](#features)
* [FAQ](#faq)
* [Known issues](#known-issues)
* [Command summary](#command-summary)
--------------------------------------------------------------------------------------------------------------------

## Quick start

1. Ensure you have Java 11 or above installed in your Computer.
1. To do this, open a command terminal and type `java --version`.
2. If you do not have Java 11 installed, get it [here](https://www.oracle.com/sg/java/technologies/javase/jdk11-archive-downloads.html).
1. To do this, open a command terminal and type `java --version`.
2. If you do not have Java 11 installed, get it [here](https://www.oracle.com/sg/java/technologies/javase/jdk11-archive-downloads.html).

2. Download the latest `ModCraft.jar` from [here](https://github.com/AY2324S1-CS2103T-T13-0/tp/releases/tag/v1.2b).

3. Copy the file to the folder you want to use as the _home folder_ for your ModCraft.

4. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar ModCraft.jar` command to run the application.<br>
A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>
A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br> <br>
![Ui](images/Ui.png)


5. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.<br>
Some example commands you can try:

* `info CS1101S` : Shows Information about the module CS1101S
* `info CS1101S` : Shows Information about the module CS1101S

* `add CS2030S y/1 s/2 g/IP` : Adds the module CS2030S to semester 2 in year 1, and marks it as In Progress.
* `add CS2030S y/1 s/2 g/IP` : Adds the module CS2030S to semester 2 in year 1, and marks it as In Progress.

* `delete CS2040S` : Deletes the module CS2040S if present from the list of modules taken
* `delete CS2040S` : Deletes the module CS2040S if present from the list of modules taken

* `exit` : Exits the app.
* `exit` : Exits the app.

6. Refer to the [Features](#features) section below for details of each command.

Expand Down Expand Up @@ -125,7 +133,7 @@ Examples:
* `info CS1010*`

### Calculating the total current CAP:
Calculates the total current CAP of all modules stored in all years and semesters
Calculates the total current CAP of all modules stored in all years and semesters
using the formula:
$\frac{\text{sum of all modules: (grade point of that module * Modular Credits of that module)}}{\text{total Modular Credits}}$.

Expand Down
Binary file modified docs/images/Ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Ui_redacted.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/helpMessage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 19 additions & 8 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,30 @@
title: ""
---

# AddressBook Level-3
[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S1-CS2103T-T13-0/tp/actions)

[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
[![codecov](https://codecov.io/gh/se-edu/addressbook-level3/branch/master/graph/badge.svg)](https://codecov.io/gh/se-edu/addressbook-level3)
## ModCraft

![Ui](images/Ui.png)

**AddressBook is a desktop application for managing your contact details.** While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).
This is **ModCraft**.<br>

* If you are interested in using AddressBook, head over to the [_Quick Start_ section of the **User Guide**](UserGuide.html#quick-start).
* If you are interested about developing AddressBook, the [**Developer Guide**](DeveloperGuide.html) is a good place to start.
ModCraft provides a fast and easy way for students to track courses to take to meet graduation requirements and plan courses to take.

Example usages:
* as a platform to plan and track your NUS modules
* as a way to keep track of your current progess in NUS,

**Acknowledgements**
The project is , optimized for users who prefer typing in CLI.
* It is **written in OOP fashion**
* It comes with a **reasonable level of user and developer documentation**.

* Libraries used: [JavaFX](https://openjfx.io/), [Jackson](https://github.com/FasterXML/jackson), [JUnit5](https://github.com/junit-team/junit5)
This project is **currently ongoing** with the following features planned:

* Viewing help
* Display Information about the module
* Add taken modules
* Delete taken modules
* See taken modules

This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
Loading