From c4bc08060a3ddd2b755f0d775e29c160fb674f9e Mon Sep 17 00:00:00 2001 From: 0nandon Date: Tue, 11 Apr 2023 02:39:10 +0800 Subject: [PATCH] change main README.md to BadMaths version --- README.md | 98 +++++++++++++++++++++++-------------------------------- 1 file changed, 40 insertions(+), 58 deletions(-) diff --git a/README.md b/README.md index 6ad2ed64c8..6dfb24d2f5 100644 --- a/README.md +++ b/README.md @@ -1,64 +1,46 @@ -# Duke project template +# _BadMaths_ ➕➖✖️➗ -This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it. +BadMaths is an integrated study tool that performs Mathematical Operations and contains various features for note-taking. -## Setting up in Intellij +To help you get started, our team has put together this user guide to guide you on the steps to operate BadMaths for your study woes. + +## Setting up Prerequisites: JDK 11 (use the exact version), update Intellij to the most recent version. 1. **Ensure Intellij JDK 11 is defined as an SDK**, as described [here](https://www.jetbrains.com/help/idea/sdk.html#set-up-jdk) -- this step is not needed if you have used JDK 11 in a previous Intellij project. -1. **Import the project _as a Gradle project_**, as described [here](https://se-education.org/guides/tutorials/intellijImportGradleProject.html). -1. **Verify the set up**: After the importing is complete, locate the `src/main/java/seedu/duke/Duke.java` file, right-click it, and choose `Run Duke.main()`. If the setup is correct, you should see something like the below: - ``` - > Task :compileJava - > Task :processResources NO-SOURCE - > Task :classes - - > Task :Duke.main() - Hello from - ____ _ - | _ \ _ _| | _____ - | | | | | | | |/ / _ \ - | |_| | |_| | < __/ - |____/ \__,_|_|\_\___| - - What is your name? - ``` - Type some word and press enter to let the execution proceed to the end. - -## Build automation using Gradle - -* This project uses Gradle for build automation and dependency management. It includes a basic build script as well (i.e. the `build.gradle` file). -* If you are new to Gradle, refer to the [Gradle Tutorial at se-education.org/guides](https://se-education.org/guides/tutorials/gradle.html). - -## Testing - -### I/O redirection tests - -* To run _I/O redirection_ tests (aka _Text UI tests_), navigate to the `text-ui-test` and run the `runtest(.bat/.sh)` script. - -### JUnit tests - -* A skeleton JUnit test (`src/test/java/seedu/duke/DukeTest.java`) is provided with this project template. -* If you are new to JUnit, refer to the [JUnit Tutorial at se-education.org/guides](https://se-education.org/guides/tutorials/junit.html). - -## Checkstyle - -* A sample CheckStyle rule configuration is provided in this project. -* If you are new to Checkstyle, refer to the [Checkstyle Tutorial at se-education.org/guides](https://se-education.org/guides/tutorials/checkstyle.html). - -## CI using GitHub Actions - -The project uses [GitHub actions](https://github.com/features/actions) for CI. When you push a commit to this repo or PR against it, GitHub actions will run automatically to build and verify the code as updated by the commit/PR. - -## Documentation - -`/docs` folder contains a skeleton version of the project documentation. - -Steps for publishing documentation to the public: -1. If you are using this project template for an individual project, go your fork on GitHub.
- If you are using this project template for a team project, go to the team fork on GitHub. -1. Click on the `settings` tab. -1. Scroll down to the `GitHub Pages` section. -1. Set the `source` as `master branch /docs folder`. -1. Optionally, use the `choose a theme` button to choose a theme for your documentation. +2. Download the latest JAR release [here](https://github.com/AY2223S2-CS2113-F10-2/tp/releases). +3. Copy the JAR file into an empty folder. +4. Open up a command window in that folder and run the following command: +``` +java -jar BadMaths.jar +``` +If the set-up is correct, you should see the following: +``` +____ _ __ __ _ _ +| _ \ | | | \/ | | | | | +| |_) | __ _ __| | | \ / | __ _| |_| |__ ___ +| _ < / _` |/ _` | | |\/| |/ _` | __| '_ \/ __| +| |_) | (_| | (_| | | | | | (_| | |_| | | \__ \ +|____/ \__,_|\__,_| |_| |_|\__,_|\__|_| |_|___/ +You can type 'Help' to learn what I can do for you :) +``` + +## Features (v2.1) +#### Monday, April 10, 2023 + +1. **Basic mathematical operations** + - Analyse trigonometry equations / sinusoidal signals + - Solve quadratic equations + - Solve matrix calculations +2. **Notes taking** + - Store, delete and list notes + - Mark or unmark the notes as done + - Rank and display notes based on priority + - Find notes based on keywords + + +Useful links: +* [User Guide](UserGuide.md) +* [Developer Guide](DeveloperGuide.md) +* [About Us](AboutUs.md)