So liest du eine GitHub-README auf Android

Eine README ist die Markdown-Datei, die ein Projekt auf GitHub vorstellt, meist README.md genannt. Um eine auf einem Android-Smartphone zu lesen, brauchst du oft nichts Neues: Dein Browser zeigt sie als formatierte Seite. Wenn du die Datei selbst haben möchtest, um sie offline zu lesen oder zu behalten, kannst du diese eine Datei oder das ganze Repository herunterladen und dann in einem Markdown-Leser öffnen. Diese Anleitung behandelt alle drei Wege.

Neu bei diesem Format? Beginne mit was eine .md-Datei ist.

Reicht der Browser?

Oft ja. Öffne die Seite des Repositorys im Browser deines Smartphones. GitHub findet eine README im Hauptordner des Repositorys, in seinem Ordner docs oder in seinem versteckten Ordner .github und zeigt sie auf dieser Seite an. Du musst nichts installieren, und ein öffentliches Repository öffnet sich ohne Anmeldung.

Auf einem schmalen Bildschirm steht die README nach den Projektdetails und der Dateiliste, scrolle also nach unten, bis du sie erreichst. Auf der Seite, die wir bei Smartphone-Breite geprüft haben, ragte breiter Inhalt über den rechten Bildschirmrand hinaus.

Eine Einschränkung solltest du kennen. GitHub schneidet eine README nach 500 KiB ab, sodass eine sehr lange möglicherweise nicht bis zum Ende angezeigt wird. Und die Seite braucht bei jedem Öffnen eine Verbindung.

Kann ich stattdessen die GitHub-App nutzen?

Du kannst es versuchen. GitHub Mobile gibt es für Android, und laut der Dokumentation von GitHub kannst du damit Repositorys durchsuchen. Diese Dokumentation beschreibt nicht, wie READMEs in der App aussehen. Der einfachste Test ist also, ein Repository zu öffnen, das dir wichtig ist, und zu sehen, ob es dir zusagt. Wenn du die App ohnehin nutzt, reicht dir das vielleicht schon.

Wie bekomme ich nur die README-Datei?

Eine einzelne Datei herunterzuladen ist der schnellste Weg, eine README zu behalten. Die Dokumentation von GitHub nennt diese Schritte:

  1. Öffne das Repository und tippe in der Dateiliste auf README.md.
  2. Tippe oben rechts in der Dateiansicht auf Raw, um den reinen Text zu sehen, oder auf das Symbol Download raw file, um ihn zu speichern.

Diese Schaltflächen sind auf einem Smartphone manchmal schwer zu erreichen. Wir haben bestätigt, dass sie auf der Seite sind, aber bei Smartphone-Breite kann dieser Teil der Seite über den Bildschirm hinausragen, sodass du eventuell seitlich scrollen musst.

Wenn du sie nicht findest, gib die Raw-Adresse der Datei selbst ein. Setze die Namen von Eigentümer, Repository und Branch ein:

https://raw.githubusercontent.com/OWNER/REPO/main/README.md

Diese Adresse liefert die Datei als reinen Text. Bei einem Repository, dessen Hauptbranch anders heißt, muss dieser Name anstelle von main stehen.

Wann sollte ich das ganze Repository herunterladen?

Lade das ganze Repository herunter, wenn die README von anderen Dateien abhängt. Eine README verweist oft mit relativen Links auf Bilder und andere Dokumente, also auf Pfade innerhalb des Repositorys. Eine einzelne heruntergeladene Datei kommt ohne sie an.

Die Dokumentation von GitHub nennt diese Schritte:

  1. Öffne die Hauptseite des Repositorys.
  2. Tippe über der Dateiliste auf Code.
  3. Tippe auf Download ZIP.

Die ZIP-Datei ist eine Momentaufnahme der Dateien ohne den Verlauf des Projekts, was zum Lesen alles ist, was du brauchst. Danach musst du sie entpacken. Der Dateimanager deines Smartphones kann das möglicherweise. Wenn nicht, brauchst du eine App, die es kann.

Wie lese ich die .md-Datei nach dem Herunterladen?

Als reiner Text geöffnet, zeigt die Datei ihre Markdown-Zeichen: # für Überschriften, ** für Fett und | für Tabellen. Ein Markdown-Leser macht daraus eine Seite. Die meisten Leser können eine Datei auf zwei Arten öffnen:

Suche einen Leser, der Tabellen und Codeblöcke zeichnet, denn READMEs verwenden sie oft. Prüfe auch, wie er mit Bildern und Links umgeht, denn die verlierst du bei einer einzelnen heruntergeladenen Datei.

Wie geht PilcrowMD mit einer README um?

PilcrowMD ist unser kostenloser Markdown-Leser für Android. Es liest Markdown im GitHub-Stil, einschließlich Tabellen, Aufgabenlisten und Hinweisboxen, und braucht kein Konto. Tippe auf seinem Startbildschirm auf Datei öffnen oder wähle es in deinem Dateimanager unter Öffnen mit.

Einige Dinge funktionieren anders als auf der GitHub-Seite:

Mehr findest du unter Markdown-Syntax auf einer Seite und Markdown privat und offline lesen.

Auch für Mac: PilcrowMD für Mac (Beta)