Documentation: Updated Readme #44

Closed
SinusFox wants to merge 7 commits from Documentation into main
3 changed files with 41 additions and 22 deletions
+4
View File
@@ -847,6 +847,10 @@ FodyWeavers.xsd
### VisualStudio Patch ### ### VisualStudio Patch ###
# Additional files built by Visual Studio # Additional files built by Visual Studio
/.idea/.gitignore
/.idea/modules.xml
/.idea/Operations-Research-Tool.iml
/.idea/vcs.xml
### Added by npx/npm for Next.JS ### ### Added by npx/npm for Next.JS ###
# dependencies # dependencies
+31 -22
View File
@@ -3,57 +3,66 @@ This projects aims to create a tool for easy calculation of operations research
## Table of Contents ## Table of Contents
- [Features](#features) - [Features](#features)
- [Installation](#installation) - [Installation/Access](#installationaccess)
- [Usage](#usage) - [Usage](#usage)
- [Supported problem Types](#supported-problem-types) - [Supported problem types](#supported-problem-types)
- [Contributing](#contributing) - [Contributing](#contributing)
- [Licence](#licence) - [Licence](#licence)
- [Contact](#contact) - [Contact](#contact)
- [Troubleshooting](#troubleshooting) - [Troubleshooting](#troubleshooting)
## Features
ToDo ## Features
## Installation - Export as LP (Linear Programming)
### On web - Measuring elapsed real time
You can always use the OR-Tool [without any installation](https://spaceholder-programming.github.io/Operations-Research-Tool/). - Logging
- Solving via GLPK and HiGHS
## Installation/Access
### Online
You can always access the Tool without any installation on our [GitHub Pages instance](https://spaceholder-programming.github.io/Operations-Research-Tool/).
### Local ### Local
1. Install dependencies: #### Install dependencies
This project relies on [NextJs](https://nextjs.org/). Please follow its [installation instructions](https://nextjs.org/docs/getting-started/installation) to get everything ready. This project relies on [NextJs](https://nextjs.org/). Please follow its [installation instructions](https://nextjs.org/docs/getting-started/installation) to get everything ready.
2. Clone the repository: #### Clone the repository
Using Git:
```Bash ```Bash
git clone https://github.com/Spaceholder-Programming/Operations-Research-Tool.git git clone https://github.com/Spaceholder-Programming/Operations-Research-Tool.git
``` ```
3. Build the site: #### Building the site
Open the folder where the project was saved in PowerShell (or your favorite console). Then build the site: Navigate towards the folder, where the project is located on your machine via terminal.
Afterwards, execute the following command:
```Bash ```Bash
npm build npm build
``` ```
4. Run it: #### Run
``` ```
npm start npm start
``` ```
5. Access the OR-Tool using your browser: #### Access the Tool using your browser:
Usually it starts on port 3000. [This link](http://localhost:3000) should work. Otherwise check your console for the link. You can access the tool via browser on your machine. The default port is 3000.
## Usage
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 ToDo
### Supported problem Types ### Supported problem types
+ Linear + Linear
+ Mixed Integer + Mixed Integer
## Contributing ## Contributing
1. Fork the repository 1. Fork the repository
2. Create a new branch: `git checkout -b Featurename` 2. Create a new branch: `git checkout -b featurename`
3. Implement your changes 3. Implement your changes
4. Push your branch: `git push origin featurename` 4. Push your branch: `git push origin featurename`
5. Create a pull request 5. Create a pull request
# Licence # Licence
This project is licensed under the [MIT License](https://github.com/Spaceholder-Programming/Operations-Research-Tool?tab=MIT-1-ov-file).
For further information, please check out the [LICENSE](https://github.com/Spaceholder-Programming/Operations-Research-Tool/blob/main/LICENCE.md).
# Contact # Contact
If you have the desire to contact the team behind this project, use the contact details on our GitHub accounts: 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) + [bRNS98](https://github.com/bRNS98)
+ [moebiusl](https://giothub.com/moebiusl) + [moebiusl](https://github.com/moebiusl)
+ [SinusFox](https://github.com/SinusFox) + [SinusFox](https://github.com/SinusFox)
+ [widepoeppihappy](https://github.com/widepoeppihappy) + [widepoeppihappy](https://github.com/widepoeppihappy)
# Troubleshooting # Troubleshooting
If you find erros in the code, please contact us by [creating an issue](https://github.com/Spaceholder-Programming/Operations-Research-Tool/issues/new). If you find bug, please contact us by [creating an issue](https://github.com/Spaceholder-Programming/Operations-Research-Tool/issues/new).
+6
View File
@@ -0,0 +1,6 @@
/// <reference types="next" />
/// <reference types="next/image-types/global" />
/// <reference types="next/navigation-types/compat/navigation" />
// NOTE: This file should not be edited
// see https://nextjs.org/docs/app/building-your-application/configuring/typescript for more information.