forked from nus-cs2103-AY2324S1/tp
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #19 from xCOLOURx/branch-readme
Update README.md
- Loading branch information
Showing
1 changed file
with
27 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,30 @@ | ||
| [](https://github.com/se-edu/addressbook-level3/actions) | ||
| [](https://github.com/AY2324S1-CS2103T-T13-0/tp/actions) | ||
|
|
||
| ## ModCraft | ||
|
|
||
|  | ||
|
|
||
| * This is **a sample project for Software Engineering (SE) students**.<br> | ||
| Example usages: | ||
| * as a starting point of a course project (as opposed to writing everything from scratch) | ||
| * as a case study | ||
| * The project simulates an ongoing software project for a desktop application (called _AddressBook_) used for managing contact details. | ||
| * It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big. | ||
| * It comes with a **reasonable level of user and developer documentation**. | ||
| * It is named `AddressBook Level 3` (`AB3` for short) because it was initially created as a part of a series of `AddressBook` projects (`Level 1`, `Level 2`, `Level 3` ...). | ||
| * For the detailed documentation of this project, see the **[Address Book Product Website](https://se-education.org/addressbook-level3)**. | ||
| * This project is a **part of the se-education.org** initiative. If you would like to contribute code to this project, see [se-education.org](https://se-education.org#https://se-education.org/#contributing) for more info. | ||
| This is **ModCraft**.<br> | ||
|
|
||
| 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, | ||
|
|
||
| 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**. | ||
|
|
||
| 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). | ||
|
|