From 997de5c4bf91b85c30e57b291b0a465e74f98c0e Mon Sep 17 00:00:00 2001
From: coolneng <akasroua@gmail.com>
Date: Thu, 16 Jul 2020 04:07:46 +0200
Subject: [PATCH] Convert readme to markdown

---
 README.md  | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 README.org |  9 ---------
 2 files changed, 48 insertions(+), 9 deletions(-)
 create mode 100644 README.md
 delete mode 100644 README.org

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..709a578
--- /dev/null
+++ b/README.md
@@ -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**
diff --git a/README.org b/README.org
deleted file mode 100644
index 3f174e7..0000000
--- a/README.org
+++ /dev/null
@@ -1,9 +0,0 @@
-* MDIS
-
-This project consists of an Information System for a Medical Institution.
-
-** Technologies
-
-- PHP
-- Javascript (AJAX)
-- MySQL