Non mi è chiaro quale sia il formato, se esistono requisiti sistematici / della riga di comando per crearlo, ecc.
Fondamentalmente, solo per conoscere le specifiche e se ci sono passi tecnici per generare il file README.
Markdown è una sintassi semplice per fornire informazioni semantiche e rappresentare la formattazione comune in testo normale. Daring Fireball ha una fantastica guida alla sintassi per il markdown standard . GitHub utilizza quindi una variante di ciò che chiamano GitHub Flavored Markdown .
Per impostare il tuo readme basta creare un semplice file di testo e chiamarlo README (o README.md / README.markdown) e inserirlo nella root del repository. GitHub lo raccoglierà come il readme del progetto.
Wikipedia - Markdown fa riferimento alla pagina "GitHub Flavored Markdown - Introduzione " ( archv. )
Citazione dalla pagina:
GitHub uses what we're calling "GitHub Flavored Markdown" (GFM) for messages, issues, and comments. It differs from standard Markdown (SM) in a few significant ways and adds some additional functionality.
La pagina fornisce anche una descrizione delle differenze rispetto a Markdown standard.
Ci sono anche altre informazioni su come viene effettivamente eseguito il rendering di Markdown da GitHub:
If you're interested in how we render Markdown files, you might want to check out Redcarpet, our Ruby interface to the Sundown library.
(Apparentemente, Sundown è l'attuale parser Markdown che viene utilizzato dietro le tende.)
Per aggiungere un ulteriore livello di astrazione, Sundown è un fork di un altro parser di Markdown :-)
Citazione dalla pagina GitHub di Sundown :
Sundown is a Markdown parser based on the original code of the Upskirt library by Natacha Porté.
È molto strano, ma sembra che GitHub non usi GitHub-Flavored Markdown (GFM) durante il rendering di un file README.
GitHub uses "GitHub Flavored Markdown," or GFM, across the site--in issues, comments, and pull requests.
Invece sembra utilizzare una versione chiamata redcarpet come parte del progetto di markup GitHub . Supportano anche molti altri formati di markup, incluso MediaWiki. Usa semplicemente l'estensione file giusta e GitHub renderà il markup.
Se vuoi vedere le differenze tra i due diversi sapori di Markdown, leggi la descrizione di GFM e le sue funzionalità extra .
Leggi altre domande sui tag github