From 88a5f717f90e0e2c31599d159144559ae5be795e Mon Sep 17 00:00:00 2001
From: David Siegfried <ds.siegfried@gmail.com>
Date: Fri, 21 Jan 2022 11:20:58 +0100
Subject: [PATCH] refine README and more, refs #121

---
 AUTHORS               |  2 +-
 INSTALL => INSTALL.md |  2 +-
 README                | 22 ----------------------
 README.md             | 22 ++++++++++++++++++++++
 UPDATE                | 19 -------------------
 UPDATE.md             | 13 +++++++++++++
 6 files changed, 37 insertions(+), 43 deletions(-)
 rename INSTALL => INSTALL.md (90%)
 delete mode 100644 README
 create mode 100644 README.md
 delete mode 100644 UPDATE
 create mode 100644 UPDATE.md

diff --git a/AUTHORS b/AUTHORS
index a941d52e0a0..731c9c54959 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -120,4 +120,4 @@ http://www.flickr.com/photos/threedots/177592275/
 Any others whose names we probably forgot to add (email us and we'll put you
 in here)
 
-- The StudIP Core Group <info@studip.de> 2021
+The StudIP Core Group <info@studip.de> 2022
diff --git a/INSTALL b/INSTALL.md
similarity index 90%
rename from INSTALL
rename to INSTALL.md
index f27991c5fdd..08d9e37cdfb 100644
--- a/INSTALL
+++ b/INSTALL.md
@@ -16,4 +16,4 @@ können.
 Also reinsehen und ausprobieren... Viel Spass damit!
 You get in an try out. Have a lot of fun!
 
-- The StudIP Core Group <info@studip.de> 2021
+The StudIP Core Group <[info@studip.de](mailto:info@studip.de)> 2022
\ No newline at end of file
diff --git a/README b/README
deleted file mode 100644
index 51dff71da57..00000000000
--- a/README
+++ /dev/null
@@ -1,22 +0,0 @@
-Stud.IP
-
-For more information on Stud.IP please visit our website at
-http://www.studip.de
-or our developer forum at
-http://develop.studip.de
-For information on how to install this package please read the INSTALL file.
-
-All files contained in this archive are licensed as stated in the COPYING
-file. Please check out the AUTHORS file to see who helped make this possible.
-
-If you find any bugs please feel free and send an e-mail to crew@studip.de.
-You can also use our bugtracker located at:
-http://develop.studip.de
-
-Future versions of this code can be downloaded from:
-http://sourceforge.net/projects/studip
-
-Thanks for taking the time to download this code. If you have any questions
-please feel free to contact us.
-
-- The StudIP Core Group <info@studip.de> 2021
diff --git a/README.md b/README.md
new file mode 100644
index 00000000000..6dc84dacd44
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+
+<p style="text-align: center">
+<a href="https://studip.de" target="_blank"><img src="https://www.studip.de/fileadmin/portal3/templates/gfx/studip_logo.svg" width="400"></a>
+</p>
+
+## Stud.IP
+For more information on Stud.IP please visit our website at [https://www.studip.de](https://www.studip.de) or our developer forum at [https://develop.studip.de](https://develop.studip.de)
+For information on how to install this package please read the INSTALL file.
+
+## License
+All files contained in this archive are licensed as stated in the COPYING
+file. Please check out the AUTHORS file to see who helped make this possible.
+
+## Bugs & Security Vulnerabilities
+If you find any bugs please feel free and send an e-mail to [crew@studip.de.](mailto:crew@studip.de.)
+You can also use our bugtracker located at: [https://gitlab.studip.de](https://gitlab.studip.de)
+
+Future versions of this code can be downloaded from: [https://gitlab.studip.de](https://gitlab.studip.de)
+
+Thanks for taking the time to download this code. If you have any questions  please feel free to contact us.
+
+- The StudIP Core Group <[info@studip.de](mailto:info@studip.de)> 2022
diff --git a/UPDATE b/UPDATE
deleted file mode 100644
index 41fb47dcbb9..00000000000
--- a/UPDATE
+++ /dev/null
@@ -1,19 +0,0 @@
-Seit der Version 1.6 gibt es einen Migrationsmechanismus für die Stud.IP Datenbank.
-Eingesetzt werden kann dieser ab einem Wechsel von Stud.IP 1.5.0-2 zu 1.6.0-1:
-- DATENSICHERUNG durchführen!
-- ACHTUNG! Der Migrationsmechanismus ist für Sprünge über mehrere major releases
-  nicht getestet! Zumindest für einen Sprung von 1.5.x auf 1.7.x oder neuer
-	sind Probleme bekannt.
-- die alten Scriptdateien durch die neuen ersetzen, dabei besonders auf die Dateien
-  im Verzeichnis config sowie auf eventuelle eigene Anpassungen achten.
-- Datenbankaktualisierungen entweder über die Webschnittstelle:
-  http://mein.server.de/studip/web_migrate.php
-- ODER über die Komandozeile:
-  studip-4.6/cli/migrate.php
-  vornehmen.
-
-- ACHTUNG! Bei einem Upgrade von Version 3.x auf Version 4.x muss die alte
-  Konfigurationsdatei config_local.inc.php noch im Konfigurationsverzeichnis liegen
-  während die Migrationen ausgeführt werden.
-
-- The StudIP Core Group <info@studip.de> 2021
diff --git a/UPDATE.md b/UPDATE.md
new file mode 100644
index 00000000000..81cdf439d90
--- /dev/null
+++ b/UPDATE.md
@@ -0,0 +1,13 @@
+Seit der Version 1.6 gibt es einen Migrationsmechanismus für die Stud.IP Datenbank.
+Eingesetzt werden kann dieser ab einem Wechsel von Stud.IP 1.5.0-2 zu 1.6.0-1:
+- **Datensicherungen** durchführen!
+- **ACHTUNG**! Der Migrationsmechanismus ist für Sprünge über mehrere major releases nicht getestet! 
+- Zumindest für einen Sprung von 1.5.x auf 1.7.x oder neuer sind Probleme bekannt.
+- die alten Script-Dateien durch die neuen ersetzen, dabei besonders auf die Dateien im Verzeichnis config sowie auf eventuelle eigene Anpassungen achten.
+- Datenbankaktualisierungen entweder über die Webschnittstelle: `http://mein.server.de/studip/web_migrate.php`
+- ODER über die Komandozeile: `studip-4.6/cli/migrate.php` vornehmen.
+
+- **ACHTUNG**! Bei einem Upgrade von Version 3.x auf Version 4.x muss die alte Konfigurationsdatei `config_local.inc.php` noch im Konfigurationsverzeichnis liegen
+  während die Migrationen ausgeführt werden.
+
+The StudIP Core Group <[info@studip.de](mailto:info@studip.de)> 2022
-- 
GitLab