Proyecto sencillo
Una breve presentación, un comando funcional y notas para contribuir.
Los banners ASCII ayudan a escanear secciones README si son compactos y legibles.
Tu banner aparece aquí.
El enlace del banner incluye el texto y los ajustes elegidos.
Usa el banner de arriba, añade los detalles y descarga un archivo Markdown.
Elige un proyecto Python sencillo, una biblioteca o una herramienta de terminal. Adapta los textos y comandos a tu proyecto; se conserva tu banner actual.
Una breve presentación, un comando funcional y notas para contribuir.
Un pequeño módulo reutilizable con un ejemplo de importación.
Un comando con un archivo de entrada y el resultado esperado.
¿Sustituir los campos del README por este ejemplo? Se conservará tu banner.
Estos campos quedan en esta página y no se incluyen en el enlace del banner. Instalación y uso se copian como código; descripción y contribuciones como texto simple.
Un README sencillo abre con una línea de texto. Uno genial abre con un banner. El arte ASCII da a tu proyecto un encabezado reconocible, separadores de sección e insignias de estado sin añadir archivos de imagen al repositorio — es solo texto, así que carga al instante y funciona en cualquier visor Git.
El Markdown de GitHub muestra el texto normal de forma proporcional, lo que destruye la alineación ASCII. Envuelve el arte en un bloque de código para que se muestre en monoespaciado:
``` +------------+ | MY PROJECT | +------------+ ```
Usa un bloque con tres comillas invertidas sin etiqueta de lenguaje para que ningún resaltador de sintaxis recoloree tu arte.
Medido con el texto completo, mayúsculas y marco elegidos. Revisa el resultado en el dispositivo de destino.
== BUILD PASSING ==.Los lectores de pantalla leen el arte ASCII carácter por carácter, así que no escondas información esencial dentro del arte. Mantén un título de texto normal junto al banner para que la página tenga sentido sin él.