Preguntas frecuentes
¿Qué incluye el README?
El nombre del proyecto y una descripción de una línea, y después las secciones que rellenes: Acerca de, Características, Instalación, Uso, Captura de pantalla, Contribuir, Licencia, Autor y Agradecimientos. Las secciones vacías se omiten, así que el README solo tiene lo que tu proyecto necesita.
¿Puede estar el README en otro idioma?
Sí. Elige inglés, español, alemán o francés como idioma del README: los títulos y las frases estándar de Contribuir, Licencia y Autor se escriben en ese idioma. Lo que escribes tú se mantiene tal cual.
¿Qué son las insignias?
Pequeñas etiquetas arriba del README para la licencia, la versión de npm y las estrellas de GitHub. Son imágenes de shields.io que GitHub muestra; nuestra vista previa las enseña como recuadros en lugar de cargarlas. Añade un repositorio de GitHub o un paquete npm para tener esas insignias.
¿Dónde pongo el archivo?
Guárdalo como README.md en la carpeta principal de tu proyecto: GitHub, GitLab y npm lo muestran en la portada del proyecto. La sección Licencia enlaza a un archivo LICENSE; GitHub puede crearlo por ti a partir de sus plantillas de licencia.
¿Se sube algo y qué cuenta como un uso?
No, el README se crea en tu navegador y lo que escribes nunca sale de tu dispositivo. Rellenar el formulario es gratis: solo copiar o descargar el README cuenta como una operación del límite diario que se muestra encima de la herramienta. Nuestro servidor solo registra ese recuento y tu dirección de red.