codex-lv2-may-2025

Navigation

2 | 3 | 4 | 5 | Current Level: 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15

---

Lesson: Update the README File as a Group

🎯 Objective

Collaborate with your group to update the README.md file in your repository. This file should describe your project, identify contributors, and outline the site layout.

---

👣 Steps

1. Open the README File

   • Go to your repository on GitHub.
   • Click on README.md.
   • Click the pencil icon to edit the file.

2. Use the Template Below Replace the placeholder content in the README with this template:

# Team Website Project

Welcome to our team website! This site was created as a collaborative project to practice working with GitHub, HTML, and CSS.

## Contributors
- Alex
- Jordan
- Sam

## Pages
- `index.html` — Home page with group introduction and links to individual pages
- `alex.html` — Alex's introduction page
- `jordan.html` — Jordan's portfolio page
- `sam.html` — Sam's favorite resources

## Purpose
To learn how to build and deploy a multi-page site as a team using GitHub Pages.

1. Edit for Accuracy

   • Update the contributor names and page descriptions as needed.
   • Add or remove lines based on your team size.

2. Commit the Changes

   • Write a clear commit message like “Update README with team info and page plan.”
   • Commit directly to the main branch.

---

✅ Practice Check

• All team members are listed as contributors
• Each HTML file is described under the Pages section
• The README uses proper markdown formatting

---

💬 Discussion Prompt

How does a good README help other people (or future you) understand your project?