Update README.md (#42)

Signed-off-by: bRNS98 <82089915+bRNS98@users.noreply.github.com>
This commit is contained in:
bRNS98
2024-10-12 00:02:07 +02:00
committed by GitHub
parent 6bc93dec53
commit a9396868d9
+18 -9
View File
@@ -7,15 +7,15 @@ This projects aims to create a tool for easy calculation of operations research
- [Usage](#usage)
- [Supported problem types](#supported-problem-types)
- [Contributing](#contributing)
- [Licence](#licence)
- [License](#license)
- [Contact](#contact)
- [Troubleshooting](#troubleshooting)
- [Issues](#issues)
## Features
- Export as LP (Linear Programming)
- Export as LP (Linear Programming) and MPS(Mathematical Programming System)
- Measuring elapsed real time
- Logging
- Solving via GLPK and HiGHS
- Solving via GLPK
## Installation/Access
### Online
@@ -32,6 +32,11 @@ git clone https://github.com/Spaceholder-Programming/Operations-Research-Tool.gi
Navigate towards the folder, where the project is located on your machine via terminal.
Afterwards, execute the following command:
```Bash
npm install
```
This installs the necessary dependencies.
Next execute:
```Bash
npm build
```
@@ -45,7 +50,11 @@ You can access the tool via browser on your machine. The default port is 3000.
If you can not reach the tool under [this link](http://localhost:3000), the default port is blocked and you have to check the terminal to get the correct port.
## Usage
ToDo
The tool provides a user-friendly interface to solve operations research problems. You can access it locally after installation or through the web interface if hosted online.
Solving a Problem
Input your model data in the boxes (constraints, variables, objective functions).
Click "Calculate" to see the results.
### Supported problem types
+ Linear
+ Mixed Integer
@@ -56,13 +65,13 @@ ToDo
3. Implement your changes
4. Push your branch: `git push origin featurename`
5. Create a pull request
# Licence
This project is licensed under the [MIT License](https://github.com/Spaceholder-Programming/Operations-Research-Tool?tab=MIT-1-ov-file).
# License
This project is licensed under the [MPL-2.0 License](https://github.com/Spaceholder-Programming/Operations-Research-Tool?tab=MPL-2.0-1-ov-file).
# Contact
If you have the desire to contact the team behind this project, use the contact details on our GitHub accounts:
+ [bRNS98](https://github.com/bRNS98)
+ [moebiusl](https://github.com/moebiusl)
+ [SinusFox](https://github.com/SinusFox)
+ [widepoeppihappy](https://github.com/widepoeppihappy)
# Troubleshooting
If you find bug, please contact us by [creating an issue](https://github.com/Spaceholder-Programming/Operations-Research-Tool/issues/new).
# Issues
If you encounter a bug, please contact us by [creating an issue](https://github.com/Spaceholder-Programming/Operations-Research-Tool/issues/new).