Basta il browser?
Spesso sì. Apri la pagina del repository nel browser del telefono. GitHub trova un README conservato nella cartella principale del repository, nella sua cartella docs o nella cartella nascosta .github, e lo mostra in quella pagina. Non devi installare nulla, e un repository pubblico si apre senza accedere.
Su uno schermo stretto, il README viene dopo i dettagli del progetto e l'elenco dei file, quindi scorri verso il basso finché non lo raggiungi. Nella pagina che abbiamo controllato con la larghezza di un telefono, il contenuto largo usciva oltre il bordo destro dello schermo.
C'è un limite da conoscere. GitHub taglia un README dopo 500 KiB, quindi uno molto lungo potrebbe non vedersi fino in fondo. E la pagina richiede una connessione ogni volta che la apri.
Posso usare invece l'app di GitHub?
Puoi provare. GitHub Mobile è disponibile per Android, e la documentazione di GitHub dice che puoi usarla per sfogliare i repository. Quella documentazione non descrive l'aspetto dei README nell'app, quindi la prova più semplice è aprire un repository che ti interessa e vedere se ti va bene. Se usi già l'app, potrebbe essere tutto ciò che ti serve.
Come ottengo solo il file README?
Scaricare un solo file è il modo più rapido per conservare un README. La documentazione di GitHub indica questi passaggi:
- Apri il repository e tocca
README.mdnell'elenco dei file. - In alto a destra nella vista del file, tocca Raw per vedere il testo semplice, oppure l'icona Download raw file per salvarlo.
Questi pulsanti possono essere difficili da raggiungere su un telefono. Abbiamo confermato che sono nella pagina, ma con la larghezza di un telefono quella parte della pagina può uscire dallo schermo, quindi potresti dover scorrere di lato.
Se non riesci a trovarli, digita tu l'indirizzo raw del file. Sostituisci i nomi del proprietario, del repository e del ramo:
https://raw.githubusercontent.com/OWNER/REPO/main/README.md
Questo indirizzo restituisce il file come testo semplice. Un repository il cui ramo principale ha un altro nome richiede quel nome al posto di main.
Quando dovrei scaricare l'intero repository?
Scarica l'intero repository quando il README dipende da altri file. Un README rimanda spesso a immagini e altri documenti con link relativi, cioè percorsi all'interno del repository. Un singolo file scaricato arriva senza di essi.
La documentazione di GitHub indica questi passaggi:
- Apri la pagina principale del repository.
- Sopra l'elenco dei file, tocca Code.
- Tocca Download ZIP.
Lo ZIP è un'istantanea dei file senza la cronologia del progetto, ed è tutto ciò che serve per leggere. Poi devi decomprimerlo. Il gestore file del telefono potrebbe riuscirci. Se non può, ti servirà un'app che lo faccia.
Come leggo il file .md dopo averlo scaricato?
Aperto come testo semplice, il file mostra i suoi simboli Markdown: # per i titoli, ** per il grassetto e | per le tabelle. Un lettore Markdown li trasforma in una pagina. La maggior parte dei lettori può aprire un file in uno di due modi:
- Dall'interno dell'app, con il suo pulsante di apertura e il selettore di file di Android.
- Dal gestore file, toccando il file e scegliendo Apri con.
Cerca un lettore che disegni tabelle e blocchi di codice, perché i README li usano spesso. Controlla anche come tratta immagini e link, dato che sono ciò che perdi con un singolo file scaricato.
Come gestisce un README PilcrowMD?
PilcrowMD è il nostro lettore Markdown gratuito per Android. Legge il Markdown in stile GitHub, comprese tabelle, elenchi di attività e riquadri di avviso, e non richiede un account. Tocca Apri file nella sua schermata di benvenuto, oppure sceglilo sotto Apri con nel gestore file.
Alcune cose funzionano diversamente dalla pagina di GitHub:
- Le immagini salvate accanto al file vengono mostrate al suo interno. Le immagini web non vengono mai scaricate, quindi un README che carica le sue immagini dal web viene mostrato senza di esse.
- I link tra file funzionano solo per le note all'interno di una cartella che aggiungi. Per un repository decompresso, aggiungi la cartella in Le mie cartelle.
- I link ai titoli nello stesso file saltano a quel titolo.
Per saperne di più, vedi la sintassi Markdown in una pagina e come leggere Markdown in privato e offline.
Anche su Mac: PilcrowMD per Mac (beta)