WIP: Update README.md for higher transparency. #3

TomatenMarc · 2023-11-29T12:13:17Z

I created an updated version of README.md which is ready for review.

This PR solves issue #1 .

MaikeMayer

Der Text gefällt mir sehr gut - schön anschaulich und kleinschnittig. Und ich mag die Emojis. Vielen Dank für die Überarbeitung.
Was mir beim Lesen aufgefallen ist: Im ersten Absatz (Zeilen 13-15) steht "ihr" und später wird die direkte Ansprache via "du" gewählt. Das würde ich vereinheitlichen. Am einfachsten scheint mir, einfach am Anfang ebenfalls die direkte Ansprache über "du" zu verwenden.

README.md

MaikeMayer · 2023-11-30T07:39:27Z

README.md

+[![Intagram](https://img.shields.io/badge/Instagram-%23E4405F.svg?style=for-the-badge&logo=Instagram&logoColor=white)](https://www.instagram.com/heicad_hhu/)
+[![Twitter](https://img.shields.io/badge/Twitter-%231DA1F2.svg?style=for-the-badge&logo=Twitter&logoColor=white)](https://twitter.com/HeiCAD_HHU)
+<a href="https://ki-campus.org/courses/kifueralle-hhu" style="width: 120px; height: 28px; background-color: #800080; padding: 2px; border-radius: 0px; display: inline-block;">
+  <img src="https://ki-campus.org/sites/default/files/color/kic_theme-ea158196/logo.svg" alt="Your Badge Alt Text">


Das Logo ist bis auf "Beta" transparent und durch die weiße Schrift daher nicht sichtbar. Ggf. müssten wir einen (lila) Hintergrund hinzufügen oder ein anderes Bild einbetten.
Noch eine doofe Frage als Laie: Was hat es mit dem alt-Text auf sich?

Der Alt-Text stammt noch aus der Vorlage und wurde entfernt!

@TomatenMarc Todo:

Bezüglich der Darstellung muss ich nochmal überlegen. Im lokalen README wird es korrekt gerendert. Im Browser (GitHub) aber nicht:

Jetzt stimmt zumindest die Größe, aber die Farbe des Hintergrundes kommt im Browser nicht durch.
Ich schaue da später mal drauf!

Alles klar, danke dir!

README.md

MaikeMayer · 2023-11-30T07:52:46Z

README.md

+## Fertig! :hugs: 
+
+Herzlichen Glückwunsch! Du hast nun erfolgreich Anaconda und Git auf deinem Computer installiert.
+Wenn du weitere Fragen hast oder Hilfe benötigst, kontaktiere uns. Viel Spaß beim Mitmachen! 😊


Wollen wir hier ggf. direkt Kontaktdaten verlinken? Oder alternativ einen Textverweis (siehe unten "Kontakt und Unterstützung")

Hatte einfach mal in die Commits geschaut und die ich gefunden hatte angegeben.

Könnte auch alle Kontaktdaten rausgeben, aber da wäre die Frage, ob alle sich mit Code/Git auskennen oder, ob wir nur eine Auswahl an Kontakten hier eintragen wollen?

Von meiner Seite aus müssen wir nicht zwingend alle Kontaktdaten verlinken. Mir ging es in dem Kommentar eher darum, hier direkt zu sagen, wie die betreffenden Personen erreicht werden können. Aber da reicht im Zweifel auch einfach ein Verweis auf die Kontaktdaten weiter unten im README

MaikeMayer · 2023-11-30T07:53:04Z

README.md

+
+## Fertig! :confetti_ball: 
+
+Du hast erfolgreich unser Repository heruntergeladen. Wenn du Fragen hast oder Hilfe benötigst, zögere nicht, uns zu kontaktieren! 😊


siehe Kommentar Zeile 61 (ggf. Kontaktdaten direkt verlinken)

MaikeMayer · 2023-11-30T07:54:11Z

README.md

+Diese Schritte zeigen, wie du ein Environment namens `AI4all_I` mithilfe der Datei `environment.yml` erstellen und anschließend ein Notebook darin starten kannst.
+Es ist wichtig, dass du weißt, wo du das Repository abgelegt hast!
+
+## Schritt 2: Öffnen von Anaconda Navigator :national_park: 


Beim Lesen war ich etwas irritiert, dass hier als erstes "Schritt 2" steht. Ist Schritt 1 abhanden gekommen oder ist bei der Nummerierung vielleicht etwas durcheinander gegangen?

ludmilahimmelspach · 2023-11-30T09:33:59Z

README.md

+## Fertig! :hugs: 
+
+Herzlichen Glückwunsch! Du hast nun erfolgreich Anaconda und Git auf deinem Computer installiert.
+Wenn du weitere Fragen hast oder Hilfe benötigst, kontaktiere uns. Viel Spaß beim Mitmachen! 😊


Ich habe mich schon gestern gefragt, ob wir auch zu Git-Installation Hilfe anbitten sollen. Das ist zwar lieb, aber ich könnte da zum Beispiel keine Fragen zur Installation auf Windows und Linux beantworten, weil ich diese Betriebsysteme nicht habe.

Das sollte soweit eigentlich kein Problem sein, man wählt auf der Seite eigentlich direkt das jeweilige System aus und folgt der Anleitung. Da könnte ich aber zur Not helfen, wenn Fragen aufkommen!

Es geht hier ja darum, diese Dateien unabhängig von unserem Projekt zur Verfügung zu stellen. In zwei Jahren ist bei uns (wahrscheinlich) niemand mehr erreichbar.

ludmilahimmelspach · 2023-11-30T09:39:34Z

README.md

+
+## Herunterladen über HTTPS :bouquet: 
+
+Folge diesen Schritten, um das Repository über HTTPS zu klonen:


Ich frage mich, ob der Begriff "klonen" auch für normale Menschen verständlich ist bzw. verständlich ist, was da passieren wird. Sonst könnte man es z.B. durch "kopieren der Dateien auf deinen Computer" ersetzen.

Wurde geändert!

ludmilahimmelspach · 2023-11-30T09:43:40Z

README.md

+Viel Spaß beim Programmieren! 😊
+
+# Kontakt und Unterstützung :handshake: 
+


Ich habe mich gerade gefragt, ob wir zu Punkten 3, 4 und 5 vielleicht die entsprechenden Links zu Anaconda Manual verlinken dürfen. Es gibt Menschen wie z.B. mich ;), die es selber hinbekommen wollen, bevor sie andere kontaktieren.

Wir verlinken auf die Anaconda-Webseite. Da sollte man auch direkt die Doku finden :-)

README.md

…ADME.md # Conflicts: # README.md

Co-authored-by: MaikeMayer <112072849+MaikeMayer@users.noreply.github.com>

README.md

Co-authored-by: MaikeMayer <112072849+MaikeMayer@users.noreply.github.com>

AKSelker

Finde ich gut, würde nur noch mal über die Ansprechpartner reden wollen, bevor wir das so hochladen.

AKSelker · 2023-12-03T10:03:15Z

README.md

+Willkommen in unserem Repository für den ersten [KI für Alle](https://ki-campus.org/courses/kifueralle-hhu)-Kurs!
+
+Hier findest du alle Jupyter Notebooks zu den Programmierteilen aus dem Kurs für die verschiedenen Wochenabschnitte.
+Stell sicher, dass du den Anweisungen folgt, damit du problemlos auf deinem eigenen Computer arbeiten kannst.


folgt -> folgst

AKSelker · 2023-12-03T10:08:08Z

README.md

+## Fertig! :hugs: 
+
+Herzlichen Glückwunsch! Du hast nun erfolgreich Anaconda und Git auf deinem Computer installiert.
+Wenn du weitere Fragen hast oder Hilfe benötigst, kontaktiere uns. Viel Spaß beim Mitmachen! 😊


Es geht hier ja darum, diese Dateien unabhängig von unserem Projekt zur Verfügung zu stellen. In zwei Jahren ist bei uns (wahrscheinlich) niemand mehr erreichbar.

AKSelker · 2023-12-03T10:08:56Z

README.md

+
+Wenn du das Repository lieber als ZIP-Datei herunterladen möchtest, folge diesen Schritten:
+
+1. Gehe zu [GitHub](https://github.com/HeiCAD/AI4all_I/).


Finde die Formulierung irreführend: "Gehe zu Github", der Link führt aber zu unserem Repository.

AKSelker · 2023-12-03T10:10:23Z

README.md

+# Erstellen eines Environment mit Anaconda Navigator :globe_with_meridians: 
+
+Diese Schritte zeigen, wie du ein Environment namens `AI4all_I` mithilfe der Datei `environment.yml` erstellen und anschließend ein Notebook darin starten kannst.
+Es ist wichtig, dass du weißt, wo du das Repository abgelegt hast!


Dieser Kommentar sollte vielleicht auch schon weiter oben beim Herunterladen stehen, meine Eltern speichern auch immer ständig was und finden es dann nicht wieder.

AKSelker · 2023-12-03T10:14:01Z

README.md

+
+Starte die `Anaconda Navigator`-Anwendung auf deinem Computer.
+
+## Schritt 3: Erstellen des Environments :nut_and_bolt: 


Die Unterpunkte in diesem Schritt beziehen sich alle auf die aktuelle Anaconda-Version. Bei neuen Versionen kann sich links, unten etc ändern. Wir sollten hier vielleicht noch die Anacondaversion angeben, in der diese Anweisungen auf jeden Fall funktionieren, und dann regelmäßig (jedes Semester) aktualisieren. Oder eher mit Screenshots arbeiten?

AKSelker · 2023-12-03T10:16:10Z

README.md

+
+Wir schätzen deine Beteiligung und stehen bereit, um sicherzustellen, dass dein Beitrag erfolgreich ist! 😊
+
+Beep Boop: Dein HeiCAD-Team :robot:


Hier vielleicht noch die Heicad-Seite verlinken? Wer weiß, wie lange die oben genannten Ansprechpartner bleiben, auf der Heicad-Seite wird es immer aktuelle Ansprechpartner zu finden geben.

AKSelker · 2023-12-03T10:18:01Z

README.md

+
+Falls du Fragen hast, Probleme auftreten oder du einfach nur mit uns in Kontakt treten möchtest, stehen wir dir gerne zur Verfügung. Hier sind verschiedene Möglichkeiten, wie du uns erreichen kannst:
+
+## Mitglieder des Teams: :alien: :vulcan_salute: 


Ich habe ein Problem damit, hier spezifische Namen als Ansprechpartner zu geben. Nachdem Joana gegangen war, musste sie ständig noch Dinge weiterleiten, die an ihre Emailadresse gingen. Besser die Funktionsemailadresse angeben, da sitzt immer jemand hinter und kann die Mails an die entsprechenden Personen weiterleiten.

MaikeMayer · 2023-12-07T07:30:36Z

README.md

+
+Willkommen in unserem Repository für den ersten [KI für Alle](https://ki-campus.org/courses/kifueralle-hhu)-Kurs!
+
+Hier findest du alle Jupyter Notebooks zu den Programmierteilen aus dem Kurs für die verschiedenen Wochenabschnitte.


Wir sollten hier sicherheitshalber noch einen Hinweis auf die Lizenz ergänzen, unter der das Material zur Verfügung steht. Ich glaube, bisher steht das nirgends auf Git.
Beispiel: "Das Material steht unter CC-BY 4.0 zur Verfügung." -> https://creativecommons.org/licenses/by/4.0/deed.de

Update README.md for higher transparency.

d2bcb3d

TomatenMarc added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 29, 2023

TomatenMarc requested review from MaikeMayer, AKSelker and ludmilahimmelspach November 29, 2023 12:13

TomatenMarc self-assigned this Nov 29, 2023

TomatenMarc changed the title ~~Update README.md for higher transparency.~~ WIP: Update README.md for higher transparency. Nov 29, 2023

TomatenMarc marked this pull request as draft November 29, 2023 12:15

TomatenMarc marked this pull request as ready for review November 29, 2023 12:16

MaikeMayer reviewed Nov 30, 2023

View reviewed changes

feger added 3 commits November 30, 2023 10:21

Update README.md for review about Twitter -> X

f7474db

Update README.md for review about alt-text

3c97d75

Update README.md for review "Ihr" -> "Du"

128beb7

ludmilahimmelspach reviewed Nov 30, 2023

View reviewed changes

Update README.md for review "alle Materialien" -> "Jupyter Notebooks"

aa04033

ludmilahimmelspach reviewed Nov 30, 2023

View reviewed changes

Update README.md for review "Download von ZIP"

1cca6b6

ludmilahimmelspach reviewed Nov 30, 2023

View reviewed changes

Update README.md for review "Git als Alternative"

dbc837d

MaikeMayer reviewed Nov 30, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

feger and others added 6 commits November 30, 2023 10:55

Update README.md to adjust the size of "Ki-Campus Badge"

12ba6c8

Add background style to Ki-Campus Badge

fadc583

Add background style to Ki-Campus Badge

465c837

Merge remote-tracking branch 'origin/update/README.md' into update/RE…

27b0764

…ADME.md # Conflicts: # README.md

Change README for review "klonen -> downloaden"

096d813

Update README.md for suggestion "ZIP"

6bdc7e9

Co-authored-by: MaikeMayer <112072849+MaikeMayer@users.noreply.github.com>

MaikeMayer reviewed Nov 30, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

Update README.md for suggestion ZIP

f3d6e03

Co-authored-by: MaikeMayer <112072849+MaikeMayer@users.noreply.github.com>

AKSelker reviewed Dec 3, 2023

View reviewed changes

MaikeMayer reviewed Dec 7, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP: Update README.md for higher transparency. #3

WIP: Update README.md for higher transparency. #3

TomatenMarc commented Nov 29, 2023 •

edited

Loading

MaikeMayer left a comment

MaikeMayer Nov 30, 2023

TomatenMarc Nov 30, 2023

TomatenMarc Nov 30, 2023

TomatenMarc Nov 30, 2023

MaikeMayer Nov 30, 2023

MaikeMayer Nov 30, 2023

TomatenMarc Nov 30, 2023

MaikeMayer Nov 30, 2023

MaikeMayer Nov 30, 2023

MaikeMayer Nov 30, 2023

ludmilahimmelspach Nov 30, 2023

TomatenMarc Nov 30, 2023

AKSelker Dec 3, 2023

ludmilahimmelspach Nov 30, 2023

TomatenMarc Nov 30, 2023

ludmilahimmelspach Nov 30, 2023

TomatenMarc Nov 30, 2023

AKSelker left a comment

AKSelker Dec 3, 2023

AKSelker Dec 3, 2023

AKSelker Dec 3, 2023

AKSelker Dec 3, 2023

AKSelker Dec 3, 2023

AKSelker Dec 3, 2023

AKSelker Dec 3, 2023

MaikeMayer Dec 7, 2023


		## Fertig! :confetti_ball:

		Du hast erfolgreich unser Repository heruntergeladen. Wenn du Fragen hast oder Hilfe benötigst, zögere nicht, uns zu kontaktieren! 😊


		## Herunterladen über HTTPS :bouquet:

		Folge diesen Schritten, um das Repository über HTTPS zu klonen:

		Viel Spaß beim Programmieren! 😊

		# Kontakt und Unterstützung :handshake:


		Wenn du das Repository lieber als ZIP-Datei herunterladen möchtest, folge diesen Schritten:

		1. Gehe zu [GitHub](https://github.com/HeiCAD/AI4all_I/).


		Starte die `Anaconda Navigator`-Anwendung auf deinem Computer.

		## Schritt 3: Erstellen des Environments :nut_and_bolt:


		Wir schätzen deine Beteiligung und stehen bereit, um sicherzustellen, dass dein Beitrag erfolgreich ist! 😊

		Beep Boop: Dein HeiCAD-Team :robot:


		Falls du Fragen hast, Probleme auftreten oder du einfach nur mit uns in Kontakt treten möchtest, stehen wir dir gerne zur Verfügung. Hier sind verschiedene Möglichkeiten, wie du uns erreichen kannst:

		## Mitglieder des Teams: :alien: :vulcan_salute:


		Willkommen in unserem Repository für den ersten [KI für Alle](https://ki-campus.org/courses/kifueralle-hhu)-Kurs!

		Hier findest du alle Jupyter Notebooks zu den Programmierteilen aus dem Kurs für die verschiedenen Wochenabschnitte.

WIP: Update README.md for higher transparency. #3

Are you sure you want to change the base?

WIP: Update README.md for higher transparency. #3

Conversation

TomatenMarc commented Nov 29, 2023 • edited Loading

MaikeMayer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AKSelker left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TomatenMarc commented Nov 29, 2023 •

edited

Loading