remove german readme and add development readme #269

README-ENG.md

@@ -1,27 +0,0 @@
-# Installation of Engelsystem
-
-## Requirements:
- * PHP 5.4.x (cgi-fcgi)
- * MySQL-Server 5.5.x
- * Webserver, i.e. lighttpd, nginx, or Apache
-
-## Directions:
- * Clone the master branch: `git clone https://github.com/engelsystem/engelsystem.git`
- * Install [Composer](https://getcomposer.org/download/)
- * Install project dependencies: `composer install`
- * Webserver must have write access to the 'import' directory and read access for all other directories
- * Webserver must be public.
-
- * Recommended: Directory Listing should be disabled.
- * There must a be MySQL database created with a user who has full rights to that database.
- * It must be created by the db/install.sql and db/update.sql files.
- * If necessary, create a config/config.php to override values from config/config.default.php.
- * In the browser, login with credentials admin:asdfasdf and change the password.
-
-Engelsystem can now be used.
-
-## Session Settings:
- * Make sure the config allows for sessions.
- * Both Apache and Nginx allow for different VirtualHost configurations.
-
-Report Bugs: https://github.com/engelsystem/engelsystem/issues

README.md

@@ -1,30 +1,42 @@
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/20b3b0b4e93344a29da6bec77f329e7a)](https://www.codacy.com/app/engelsystem/engelsystem)
 [![GPL](https://img.shields.io/github/license/engelsystem/engelsystem.svg?maxAge=2592000)]()
 
-# Installation eines frischen Engelsystems
+# Engelsystem
 
-## Mindestvorrausetzungen (bzw. getestet unter):
+Please visit https://engelsystem.de for a feature list.
+
+## Installation
+
+### Requirements:
  * PHP 5.4.x (cgi-fcgi)
  * MySQL-Server 5.5.x
- * Webserver mit PHP-Anbindung, z.B. lighttpd, nginx oder Apache
+ * Webserver, i.e. lighttpd, nginx, or Apache
 
-## Vorgehen:
+### Directions:
- * Klonen des `master` in lokales Verzeichnis: `git clone https://github.com/engelsystem/engelsystem.git`
+ * Clone the master branch: `git clone https://github.com/engelsystem/engelsystem.git`
- * [Composer](https://getcomposer.org/download/) installieren
+ * Install [Composer](https://getcomposer.org/download/)
- * Abhängigkeiten installieren: `composer install`
+ * Install project dependencies: `composer install`
- * Der Webserver muss Schreibrechte auf das Verzeichnis `import` bekommen, für alle anderen Dateien reichen Leserechte.
+ * Webserver must have write access to the 'import' directory and read access for all other directories
- * Der Webserver muss auf `public` als http-root zeigen.
+ * Webserver must be public.
 
- * Empfehlung: Dirlisting sollte deaktiviert sein.
+ * Recommended: Directory Listing should be disabled.
- * Es muss eine MySQL-Datenbank angelegt werden und ein User existieren, der alle Rechte auf dieser Datenbank besitzt.
+ * There must a be MySQL database created with a user who has full rights to that database.
- * Es muss die db/install.sql und die db/update.sql importiert/ausgeführt werden.
+ * It must be created by the db/install.sql and db/update.sql files.
- * Erstelle bei Bedarf eine config/config.php, die die Werte (z.B. DB-Zugang) aus der config/config.default.php überschreibt.
+ * If necessary, create a config/config.php to override values from config/config.default.php.
- * Engelsystem im Browser aufrufen, Anmeldung mit admin:asdfasdf vornehmen und Admin-Passwort ändern.
+ * In the browser, login with credentials admin:asdfasdf and change the password.
 
-Das Engelsystem ist jetzt einsatzbereit.
+Engelsystem can now be used.
 
-## Session Einstellungen:
+### Session Settings:
- * Einstellungen für Cookies und Sessions bitte in der PHP Config des Servers vornehmen.
+ * Make sure the config allows for sessions.
- * Sowohl Apache als auch nginx bieten Möglichkeiten für verschiedene Konfigurationen pro VirtualHost an
+ * Both Apache and Nginx allow for different VirtualHost configurations.
 
-Fehler bitte auf Github melden: https://github.com/engelsystem/engelsystem/issues
+Report Bugs: https://github.com/engelsystem/engelsystem/issues
+
+## Development
+Since the engelsystem is open source, you can help to improve the system. We really love to get pull requests containing fixes or implementations of our Github issues.
+
+Please create single pull requests for every feature instead of creating one big monster of pull request containing a complete rewrite.
+
+### Codestyle
+Please ensure that your pull requests follow [PSR-2](http://www.php-fig.org/psr/psr-2/) and [PSR-4](http://www.php-fig.org/psr/psr-4/).

templates/guest_credits.html

@@ -5,10 +5,12 @@
             <h2>Source code</h2>
             <p>
                 The original system was written by <a href="https://github.com/cookieBerlin/engelsystem">cookie</a>.
-                It was then completely rewritten and greatly enhanced by <a href="http://notrademark.de/">msquare</a>
+                It was then completely rewritten and enhanced by
-                and <a href="http://myigel.name/">MyIgel</a>,
+                <a href="http://notrademark.de/">msquare</a> (maintainer),
-                <a href="http://mortzu.de/">mortzu</a> of <a href="http://planetcyborg.de">planet cyborg</a>,
+                <a href="http://myigel.name/">MyIgel</a>,
-                <a href="http://jplitza.de/">jplitza</a> and gnomus.
+                <a href="http://mortzu.de/">mortzu</a>,
+                <a href="http://jplitza.de/">jplitza</a> and
+                gnomus.
             </p>
             <p>
                 Please look at the <a href="https://github.com/engelsystem/engelsystem/graphs/contributors">contributor
@@ -18,8 +20,8 @@
         <div class="col-md-4">
             <h2>Hosting</h2>
             <p>
-                Webspace, development platform and domain is currently provided by
+                Webspace, development platform and domain on <a href="https://engelsystem.de">engelsystem.de</a> is currently provided by
-                <a href="https://www.wybt.net/">would you buy this?</a> (ichdasich)<br/>
+                <a href="https://www.wybt.net/">would you buy this?</a> (ichdasich)
                 and adminstrated by <a href="http://mortzu.de/">mortzu</a>,
                 <a href="http://derf.homelinux.org/">derf</a>
                 and ichdasich.