diff --git a/README.md b/README.md index 48cf451f96af00145fed024ae07f88e47537cb95..30c0e54e3ee0fa16d27c7ad7d58e71e3ab9bc688 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,34 @@ +# Website der Video AG + +## Entwicklung +### Zum Testen: + Hinweis: diese Variante startet eine lokale Testversion der Website, es sind nicht alle Features verfügbar, z.B. LDAP-Login. + + 1. Repo Clonen + 2. Verzeichnis betreten + 3. (optional) config.py anpassen + 4. Schauen ob alle Dependencies erfüllt sind (siehe weiter unten) + 5. `./run.py` ausführen + 6. unter [link](http://localhost:5000) ist die Website verfügbar + 7. Moderatorlogin mit user: `videoag` Passwort: `videoag` + +### Zum Mitmachen: + 1. Repo zum User clonen, dafür den "Clone-Button auf der Website verwenden + 2. Weiter mit 'Zum Testen' + 3. Änderungen machen + 4. ins eigene Repo pushen + 5. Pull-Request an uns, dazu unter "Merge-Requests" einmal auf "New Merge Request" und das Private Repo auswählen. + 6. Warten + 7. Wir mergen die Änderungen + +### Dependencies + * python + * flask + * sqlite + * lxml (optional, wird für den Campus Import benötigt) + +# Lizenz + This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License Version 2 as published by the Free Software Foundation; @@ -9,4 +40,4 @@ GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software -Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. \ No newline at end of file +Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.