Ir al contenido

Aviso de carpeta (README)

Si crea un archivo README.md en una carpeta, su contenido aparece automáticamente debajo de la lista cada vez que abre la carpeta. Puede usarlo para comunicar a los miembros del equipo reglas de uso o información del proyecto. Un aviso en cada carpeta permite que esta funcione como su propia página informativa sin necesidad de un wiki interno independiente.


Antes de empezar

  • Configuración del administrador: debe estar activado Show README.md Immediately en Service Config > File Area para que el README aparezca automáticamente al abrir la carpeta.

Cargar un archivo README.md

Cree o cargue un archivo README.md dentro de la carpeta. Escriba en Markdown las convenciones de nombres, las instrucciones de la carpeta, el progreso del proyecto u otra información.

Crear un borrador a partir de la estructura

Si no desea empezar desde cero, genere un borrador con la estructura de carpetas y la lista de archivos.

Seleccione Organize en la parte superior de la carpeta y, en la pestaña Create README, seleccione Create File.

Se crea en la carpeta un archivo README.md con la lista de carpetas y archivos de la ubicación actual. Edítelo para usarlo como borrador. Si ya existe README.md, elija Save As u Overwrite.

Crear un README

Ver el contenido

Al abrir la carpeta, el contenido de README.md aparece automáticamente debajo de la lista de archivos.

Ejemplo de README

Información útil

  • Solo se reconoce un README por carpeta.
  • Se reconocen tanto mayúsculas como minúsculas.

Documentos relacionados