From e1ffc62350c92ae6bed6ae3710ed8bd8482751bd Mon Sep 17 00:00:00 2001
From: SinusFox <61253950+SinusFox@users.noreply.github.com>
Date: Sun, 6 Oct 2024 20:23:21 +0200
Subject: [PATCH] Updating README and .gitignore (#20)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* Initial Push

Inititial project state

* Static demo version

* static demo site - added variables

a

* first_implementation

* Updated UI, Improved Style to be more "Reactly", added Functionality

* add parsing functions

* change folder

* Import/Export Prototype

* Adding "reactjs-popup" to package,json

* Adding GLPK source

* Rough implementation of solver + example

* Show solution in output

* example 2 + popup lib

* removing import button

This feature won't be needed in this state of the project and might come back later. Right now it serves no functional purpose.

* Removing "Popout" button

This feature won't be needed in this state of the project and might come back later. Right now it serves no functional purpose.

* Updating Logs

Now the site displays all logs created with customLog(STRING). Logs can be cleared with customLogClear();

* Adding walltime

Can be called using:

Start:
function walltimeStart() {
returns Date.now();

Stop:
function walltimeStopAndPrint(startpoint: number) {
Add startpoint as argument.
It prints the elapsed time using customLog()

* Adding duals ouput

* Adding glpk.js package

required dependency

* adding LP format export and fixing a few errors

* fixing further errors

* adding automatic build

* Moving files to correct folders

* Update nextjs.yml

* Updating README and .gitignore

README:
- added installation instructions
- added troubleshooting

gitignore:
- skipping Writerside and .idea folders

---------

Signed-off-by: SinusFox <61253950+SinusFox@users.noreply.github.com>
Co-authored-by: moebiusl <lucas.moebius@icloud.com>
Co-authored-by: Marcel Pöppe <marcel.poeppe@gmail.com>
---
 .gitignore |  7 +++++++
 README.md  | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 63 insertions(+)

diff --git a/.gitignore b/.gitignore
index 4fdf2a3..4290ad5 100644
--- a/.gitignore
+++ b/.gitignore
@@ -883,3 +883,10 @@ yarn-error.log*
 # typescript
 *.tsbuildinfo
 next-env.d.ts
+
+## adding local stuff
+# idea
+/.idea
+
+# Writerside
+/Writerside
diff --git a/README.md b/README.md
index 1c7d679..7f36f9a 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,58 @@
 # University-Operations-Research-Tool
 This projects aims to create a tool for easy calculation of operations research modules on different device platforms.
+
+## Table of Contents
+- [Features](#features) 
+- [Installation](#installation)
+- [Usage](#usage)
+- [Supported problem Types](#supported-problem-types)
+- [Contributing](#contributing)
+- [Licence](#licence)
+- [Contact](#contact)
+- [Troubleshooting](#troubleshooting)
+## Features 
+ToDo
+## Installation 
+### On web
+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
+git clone https://github.com/Spaceholder-Programming/Operations-Research-Tool.git
+```
+3. Build the site:
+Open the folder where the project was saved in PowerShell (or your favorite console). Then build the site:
+```Bash
+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
+
+ToDo
+### Supported problem Types
++ Linear
++ Mixed Integer
+
+## Contributing
+1. Fork the repository
+2. Create a new branch: `git checkout -b Featurename`
+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).
+# 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://giothub.com/moebiusl)
++ [SinusFox](https://github.com/SinusFox)
++ [widepoeppihappy](https://github.com/widepoeppihappy)
+# 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).