Create a clear README in 10 minutes with GitHub Copilot

Open your repository and start the README file

Open your repository on GitHub in your browser. You’ll land on the main page showing your project files. Look for a list of files; if you just created the repo, you may see only a .gitignore file or nothing yet. At the top-right of the file list, click Add file and choose Create new file. Name the file README.md. The .md stands for “Markdown,” a simple way to format text with symbols like # for headings.

You’ll see a blank editor with a placeholder: “Write a new file in …”. The file name README.md tells GitHub this is the project’s welcome page.

You'll know it worked when you see the filename README.md at the top of the editor and the page title says “Create new file”.

Ask Copilot to generate the README structure

With the file open, press the Ask Copilot button (usually a chat icon or a sparkle) in the top-right corner of the editor. If you don’t see it, look for a Copilot icon in the toolbar or use the shortcut Ctrl+I (Windows/Linux) or Cmd+I (Mac). A chat panel opens on the right.

In the chat box, type:

Press Enter. Copilot will respond with a suggested structure using Markdown headings like # Description, ## Features, etc. It may also add a short placeholder paragraph under each heading.

You'll know it worked when you see a list of headings and brief descriptions appear in the editor, replacing the blank page.

Fill in the project description

Scroll to the # Description section Copilot created. Replace the placeholder text with a clear, one-sentence explanation of your project. For example, if your project is a Python script that counts words, write:

You'll know it worked when the description reads like a friendly introduction and fits naturally under the heading.

List the project’s features

Under the ## Features heading, Copilot likely added a bullet list. Replace each bullet with a short, active phrase describing what your project does. For a word counter, it might look like:

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

You'll know it worked when the list clearly shows what the project can do, using simple language.

Add installation instructions

Scroll to the ## Installation section. Copilot usually suggests commands like pip install or git clone. Replace the placeholder with step-by-step instructions for your operating system. For a beginner-friendly Python project, write:

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.)

You'll know it worked when the instructions are clear enough for someone with basic computer skills to follow without confusion.

Write a usage example

Under the ## Usage heading, Copilot often adds a code block with a command like python wordcounter.py. Replace it with a simple, copy-paste-ready example. For a word counter, write:

python wordcounter.py sample.txt

You'll know it worked when the example is short, uses real file names, and shows exactly what to type.

Choose a license and add it

Scroll to the ## License section. Copilot may suggest a placeholder like “MIT License” or “Apache 2.0”. Replace it with a short explanation and a link to the license file. For beginners, the MIT License is simple and widely used. Write:

You'll know it worked when the license section clearly states the license type and links to a file named LICENSE in your repo.