finalrequest #59

Closed
SinusFox wants to merge 10 commits from Documentation into main
Showing only changes of commit 9b70579411 - Show all commits
+18 -7
View File
@@ -9,19 +9,30 @@ This projects aims to create a tool for easy calculation of operations research
- [Contributing](#contributing) - [Contributing](#contributing)
- [Licence](#licence) - [Licence](#licence)
- [Contact](#contact) - [Contact](#contact)
-[Troubleshooting](#troubleshooting) - [Troubleshooting](#troubleshooting)
## Features ## Features
ToDo ToDo
## Installation ## Installation
### Prerequisites ### On web
1. Clone the repository: You can always use the OR-Tool [without any installation](https://spaceholder-programming.github.io/Operations-Research-Tool/).
### Local
1. 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.
2. Clone the repository:
```Bash ```Bash
git clone https://github.com/Spaceholder-Programming/Operations-Research-Tool.git git clone https://github.com/Spaceholder-Programming/Operations-Research-Tool.git
``` ```
2. Install dependencies 3. Build the site:
Open the folder where the project was saved in PowerShell (or your favorite console). Then build the site:
```Bash ```Bash
ToDo npm build
``` ```
4. Run it:
```
npm start
```
5. Access the OR-Tool using your browser:
Usually it starts on port 3000. [This link](http://localhost:3000) should work. Otherwise check your console for the link.
## Usage ## Usage
ToDo ToDo
@@ -44,6 +55,6 @@ If you have the desire to contact the team behind this project, use the contact
+ [SinusFox](https://github.com/SinusFox) + [SinusFox](https://github.com/SinusFox)
+ [widepoeppihappy](https://github.com/widepoeppihappy) + [widepoeppihappy](https://github.com/widepoeppihappy)
# Troubleshooting # Troubleshooting
ToDo If you find erros in the code, please contact us by [creating an issue](https://github.com/Spaceholder-Programming/Operations-Research-Tool/issues/new).