From 75d26b20664ebdcc1ba272d443dec6712ed3f3ce Mon Sep 17 00:00:00 2001 From: LMzK <73669620+L-MzK@users.noreply.github.com> Date: Wed, 12 May 2021 14:14:15 +0200 Subject: [PATCH] Create README.md --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..4086541 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# fernuni-bot a.k.a. Boty McBotface +*Bot für den Discord Server "FU Hagen Informatik/Mathematik"* + +## Funktion +### April 2020 +✨*Geburtstunde* +**Ursprünglich**: Rollenzuschreibung / -entfernung auf dem Server (Studiengangszugehörigkeit). + +### Mai 2021 +**Rolle**: Freund und Helfer bei der Organisation des Studiums und der gelegentlichen Prokrastination 🤖 + +* Begrüßung von neuen Servermitgliedern + * Direktnachricht + * Text in #welcome (WIP - [Issue zum Thema](https://github.com/FU-Hagen-Discord/fernuni-bot/issues/27)) +* Rollenzuschreibung / -entfernung + * Studiengangszugehörigkeit + * [Newsrolle](https://github.com/FU-Hagen-Discord/fernuni-bot/blob/master/news_cog.py) -> Ping bei Neuigkeiten der Fak. für Informatik und Mathematik + * Farben für Usernames + * *Sonstige Rollen bei saisonalen Events* +* Wissensmanagement + * Modulinformationen : [PR zur Funktion](https://github.com/FU-Hagen-Discord/fernuni-bot/pull/3) + * Sammlung Nützlicher [Links](https://github.com/FU-Hagen-Discord/fernuni-bot/blob/master/links_cog.py) in den Channels +* [Lerngruppenverwaltung](https://github.com/FU-Hagen-Discord/fernuni-bot/blob/master/learninggroups.py) + * Anfragen/ Erstellen/ Umbenennen/ Löschen + * Ownership -> Toggle: 🔴vollzählig/ 🌲offen für neue Mitglieder +* [Kalenderfunktion](https://github.com/FU-Hagen-Discord/fernuni-bot/blob/master/appointments_cog.py) +* [Umfragefunktion](https://github.com/FU-Hagen-Discord/fernuni-bot/blob/master/poll_cog.py) +* Text-commands + * Motivations- / Prokrastinationssprüche + * Statistiken des Servers anzeigen + * [Arminsagt-Sprüche](https://github.com/FU-Hagen-Discord/fernuni-bot/blob/master/armin.py) +* (Saisonal) Event-Funktionen + +## Contributing guide</h2> +Tipp: [Issues](https://github.com/FU-Hagen-Discord/fernuni-bot/issues) anschauen und +* eine nicht-attribuierte Issue, die den Label **good first issue** trägt, bearbeiten. +* Bedürfnis entdeckt, der noch keine Issue hat? Issue erstellen und auf Rückmeldung warten 👍 -- GitLab