Crea un README claro en 10 minutos con GitHub Copilot

Abre tu repositorio y empieza el archivo README

Abre tu repositorio en GitHub en tu navegador. Aterrizarás en la página principal que muestra los archivos de tu proyecto. Busca una lista de archivos; si acabas de crear el repositorio, es posible que solo veas un archivo .gitignore o nada aún. En la esquina superior derecha de la lista de archivos, haz clic en Add file (Añadir archivo) y elige Create new file (Crear nuevo archivo). Nombra el archivo README.md. El .md significa "Markdown", una forma sencilla de formatear texto con símbolos como # para los encabezados.

Verás un editor en blanco con un marcador de posición: "Write a new file in …" (Escribir un nuevo archivo en...). El nombre del archivo README.md le indica a GitHub que esta es la página de bienvenida del proyecto.

Sabrás que funcionó cuando veas el nombre del archivo README.md en la parte superior del editor y el título de la página diga "Create new file" (Crear nuevo archivo).

Pide a Copilot que genere la estructura del README

Con el archivo abierto, pulsa el botón Ask Copilot (Preguntar a Copilot) (normalmente un icono de chat o una estrella) en la esquina superior derecha del editor. Si no lo ves, busca un icono de Copilot en la barra de herramientas o usa el atajo Ctrl+I (Windows/Linux) o Cmd+I (Mac). Se abrirá un panel de chat a la derecha.

En el cuadro de chat, escribe:

Pulsa Enter. Copilot responderá con una estructura sugerida utilizando encabezados de Markdown como # Descripción, ## Características, etc. También puede añadir un breve párrafo de marcador de posición debajo de cada encabezado.

Sabrás que funcionó cuando veas una lista de encabezados y descripciones breves aparecer en el editor, reemplazando la página en blanco.

Rellena la descripción del proyecto

Desplázate hasta la sección # Description (Descripción) que Copilot creó. Reemplaza el texto de marcador de posición con una explicación clara y de una sola frase de tu proyecto. Por ejemplo, si tu proyecto es un script de Python que cuenta palabras, escribe:

Sabrás que funcionó cuando la descripción se lea como una introducción amigable y encaje naturalmente bajo el encabezado.

Enumera las características del proyecto

Bajo el encabezado ## Features (Características), Copilot probablemente añadió una lista con viñetas. Reemplaza cada viñeta con una frase corta y activa que describa lo que hace tu proyecto. Para un contador de palabras, podría verse así:

• Funciona con archivos .txt en Windows, macOS y Linux
• Ligero y se ejecuta en segundos
• No requiere librerías externas

Sabrás que funcionó cuando la lista muestre claramente lo que el proyecto puede hacer, utilizando un lenguaje sencillo.

Añade las instrucciones de instalación

Desplázate hasta la sección ## Installation (Instalación). Copilot normalmente sugiere comandos como pip install o git clone. Reemplaza el marcador de posición con instrucciones paso a paso para tu sistema operativo. Para un proyecto de Python fácil de usar para principiantes, escribe:

python --version Si ves Python 3.x, estás listo. 2. Descarga o clona este proyecto: git clone https://github.com/your-username/your-repo.git 3. Muévete a la carpeta del proyecto: cd your-repo 4. Instala el paquete requerido (si lo hay): pip install -r requirements.txt (Si no hay un archivo requirements.txt, omite este paso.)

Sabrás que funcionó cuando las instrucciones sean lo suficientemente claras para que alguien con conocimientos informáticos básicos pueda seguirlas sin confusión.

Escribe un ejemplo de uso

Bajo el encabezado ## Usage (Uso), Copilot a menudo añade un bloque de código con un comando como python wordcounter.py. Reemplázalo con un ejemplo sencillo, listo para copiar y pegar. Para un contador de palabras, escribe:

python wordcounter.py sample.txt

Sabrás que funcionó cuando el ejemplo sea corto, use nombres de archivo reales y muestre exactamente qué escribir.

Elige una licencia y añádela

Desplázate hasta la sección ## License (Licencia). Copilot puede sugerir un marcador de posición como "MIT License" o "Apache 2.0". Reemplázalo con una breve explicación y un enlace al archivo de la licencia. Para principiantes, la Licencia MIT es sencilla y ampliamente utilizada. Escribe:

Sabrás que funcionó cuando la sección de la licencia indique claramente el tipo de licencia y enlace a un archivo llamado LICENSE en tu repositorio.