Convert readme to markdown

This commit is contained in:
coolneng 2020-07-16 04:07:46 +02:00
parent 6e314bc2a0
commit 997de5c4bf
Signed by: coolneng
GPG Key ID: 9893DA236405AF57
2 changed files with 48 additions and 9 deletions

48
README.md Normal file
View File

@ -0,0 +1,48 @@
# MDIS
This project consists of an Information System for a Medical Institution.
## Technologies
- PHP
- MySQL
- Javascript
- Fullcalendar
- Jquery
- JqueryUI
## Requirements
- Nix
## Installation
1. Install Nix (compatible with Nix and Linux):
``` {.shell}
curl -L https://nixos.org/nix/install | sh
```
There are alternative installation methods, if you don\'t want to pipe
curl to sh
2. Clone the repository:
``` {.shell}
git clone https://coolneng.duckdns.org/gitea/coolneng/MDIS
```
3. Change the working directory to the project:
``` {.shell}
cd MDIS
```
4. Enter the nix-shell:
``` {.shell}
nix-shell
```
The website can be accessed via **localhost:8000**

View File

@ -1,9 +0,0 @@
* MDIS
This project consists of an Information System for a Medical Institution.
** Technologies
- PHP
- Javascript (AJAX)
- MySQL