edit readme

This commit is contained in:
TimmensOne 2023-04-04 20:12:37 +02:00
parent d24d167436
commit 50acb5fd41

View File

@ -1,13 +1,22 @@
# Abschlussprojekt Device Manager Timon Lorenz (WIP)
The goal of this project is to develop a web application which manages the devices of the Univesity Regensburg. It is currently in devlopment.
## Description (WIP)
## Table of contents
1. Description
2. Instalation
- Requirements
- Getting Started
3. Usage
4. Testing
5.
## 1 Description (WIP)
- Device List
- Device Detail
- device add
- Device History
## Installation
## 2 Installation
In this section, all requirements are defined first. This is followed by a step by step installation. Finally some general information
### Requirements
#### Docker
@ -98,16 +107,20 @@ Add following line:
alias sail='[ -f sail ] && bash sail || bash vendor/bin/sail'
```
## Usage (WIP)
## 3 Usage (WIP)
- User story
## Author (WIP)
## 4 Testing
To test the application run the following code inside the project directory `device-app`:
```sh
php artisan test
```
## 5 Author
Timon Lorenz (lot17014)
## License (WIP)
propably MIT
## 6 License
This project is licensed with the MIT license. The used framework [Laravel](https://laravel.com/) and the imported [Log-Viewer](https://github.com/opcodesio/log-viewer/discussions) are also licensed with the MIT license.
## Releasedate
latest: 15.04.2023