Acerca de los archivos README
Puedes agregar un archivo README a un repositorio para comunicar información importante sobre tu proyecto. El contar con un README, en conjunto con una licencia de repositorio, archivo de citas, lineamientos de contribución y código de conducta, comunica las expectativas de tu proyecto y te ayuda a administrar las contribuciones.
Para obtener más información acerca de cómo proporcionar lineamientos para tu proyecto, consulta la sección "Agregar un código de conducta para tu proyecto" y "Configurar tu proyecto para que tenga contribuciones sanas".
Un archivo README suele ser el primer elemento que verá un visitante cuando entre a tu repositorio. Los archivos README habitualmente incluyen información sobre:
- Qué hace el proyecto.
- Por qué el proyecto es útil.
- Cómo pueden comenzar los usuarios con el proyecto.
- Dónde pueden recibir ayuda los usuarios con tu proyecto
- Quién mantiene y contribuye con el proyecto.
Si pones tu archivo de README en el .github oculto de tu repositorio, en la raíz o en el directorio docs, GitHub Enterprise Cloud lo reconocerá y lo hará emerger automáticamente para los visitantes del repositorio.
Si un repositorio contiene más de un archivo README, entonces el archivo que se muestra se elegirá de las ubicaciones en el siguiente orden: el directorio de .github, luego el directorio raíz del repositorio y, finalmente, el directorio docs.
Si agregas un archivo de README a la raíz de un repositorio público con el mismo nombre que tu nombre de usuario, dicho README aparecerá automáticamente en tu página de perfil. Puedes editar el README de tu perfil con el Marcado Enriquecido de GitHub para crear una sección personalizada en tu perfil. Para obtener más información, consulta la sección "Administrar el README de tu perfil".
Índice auto-generado de los archivos README
Para la versión interpretada de cualquier archivo de lenguaje de marcado en un repositorio, incluyendo los archivos README, GitHub Enterprise Cloud generará un índice automáticamente con base en los encabezados de sección. Puedes ver el índice de un archivo README si haces clic en el icono de menú en la parte superior izquierda de la página interpretada.
Enlaces de sección en los archivos README y las páginas blob
Puedes vincular directamente a una sección en un archivo expedido si deslizas el puntero sobre el encabezado de la sección para exponer el enlace:
Enlaces relativos y rutas con imágenes en los archivos README
Puedes definir enlaces relativos y rutas de imagen en los archivos representados para ayudar a que los lectores naveguen hasta otros archivos de tu repositorio.
Un enlace relativo es un enlace que es relativo al archivo actual. Por ejemplo, si tienes un archivo README en la raíz de tu repositorio y tienes otro archivo en docs/CONTRIBUTING.md, el enlace relativo a CONTRIBUTING.md en tu archivo README podría verse así:
[Contribution guidelines for this project](docs/CONTRIBUTING.md)
GitHub Enterprise Cloud transformará de manera automática el enlace relativo o la ruta de imagen en cualquier rama en la que te encuentres actualmente, de modo que el enlace o ruta siempre funcione. La ruta del enlace será relativa al archivo actual. Los enlaces que comienzan con / serán relativos a la raíz del repositorio. Puedes usar todos los operandos del enlace relativo, como ./ y ../.
Los enlaces relativos son más sencillos para los usuarios que clonan tu repositorio. Puede que los enlaces absolutos no funcionen en los clones de tu repositorio. Recomendamos usar enlaces relativos para consultar los archivos dentro de tu repositorio.
Wikis
Un archivo README debe contener solo la información necesaria para que los desarrolladores comiencen a hacer contribuciones en tu proyecto. La documentación más grande es mejor para los wikis. Para obtener más información, consulta la sección "Acerca de los wikis".