Crea un README claro en 10 minutos con GitHub Copilot

Abre tu repositorio y crea el archivo README

Abre tu repositorio en GitHub desde el navegador. Llegarás a la página principal con los archivos de tu proyecto. Busca la lista de archivos; si acabas de crear el repo, puede que solo veas un archivo .gitignore o nada todavía. En la esquina superior derecha de la lista de archivos, haz clic en Add file y elige Create new file. Nombra el archivo README.md. El .md significa “Markdown”, una forma sencilla de dar formato al texto con símbolos como # para los títulos.

Verás un editor en blanco con un texto de ejemplo: “Write a new file in …”. El nombre README.md le indica a GitHub que esta es la página de bienvenida del proyecto.

README.md

Sabrás que funcionó cuando veas el nombre README.md en la parte superior del editor y el título de la página diga “Create new file”.

Pídele a Copilot que genere la estructura del README

Con el archivo abierto, pulsa el botón Ask 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 usando títulos de Markdown como # Description, ## Features, etc. También puede añadir un párrafo breve de ejemplo bajo cada título.

Sabrás que funcionó cuando aparezca una lista de títulos y descripciones breves en el editor, reemplazando la página en blanco.

Completa la descripción del proyecto

Desplázate hasta la sección # Description que creó Copilot. Sustituye el texto de ejemplo por una explicación clara, en una sola frase, de tu proyecto. Por ejemplo, si tu proyecto es un script en Python que cuenta palabras, escribe:

Sabrás que funcionó cuando la descripción se lea como una introducción amigable y encaje de forma natural bajo el título.

Lista las características del proyecto

Bajo el título ## Features, es probable que Copilot haya añadido una lista con viñetas. Sustituye cada viñeta por una frase corta y activa que describa lo que hace tu proyecto. Para un contador de palabras, podría verse así:

• Works with .txt files on Windows, macOS, and Linux
• Lightweight and runs in seconds
• No external libraries required

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

Añade las instrucciones de instalación

Desplázate a la sección ## Installation. Copilot suele sugerir comandos como pip install o git clone. Sustituye el texto de ejemplo por instrucciones paso a paso para tu sistema operativo. Para un proyecto en Python pensado para principiantes, escribe:

python --version If you see Python 3.x, you’re good to go. 2. Download or clone this project: git clone https://github.com/your-username/your-repo.git 3. Move into the project folder: cd your-repo 4. Install the required package (if any): pip install -r requirements.txt (If there’s no requirements.txt, skip this step.)

Sabrás que funcionó cuando las instrucciones sean lo bastante claras para que alguien con conocimientos básicos de informática pueda seguirlas sin confundirse.

Escribe un ejemplo de uso

Bajo el título ## Usage, Copilot a menudo añade un bloque de código con un comando como python wordcounter.py. Sustitúyelo por 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 lo que hay que escribir.

Elige una licencia y añádela

Desplázate hasta la sección ## License. Es posible que Copilot sugiera algo como “MIT License” o “Apache 2.0”. Sustitúyelo por una explicación breve y un enlace al archivo de la licencia. Para principiantes, la MIT License es sencilla y muy usada. Escribe:

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