← Week 3
DESN 368

Make Your README Your Own

Week 3 · Homework · 10 pts

Two Audiences, Two Documents

Your repo serves two different audiences with two different files:

  • README.md is for people browsing your GitHub repo — developers, classmates, your future self. It's written in Markdown.
  • index.html is for people visiting your website — anyone on the web. It's written in HTML/CSS.
  • Same repo, different audiences. Both matter.
Step 1

Remove the Setup Stuff

Open README.md in Codespaces. You’re going to clean it up — not delete everything, just remove the parts that were only needed for onboarding.

Remove these sections:

  • NEXT STEPS - START HERE — Steps 1–5 (account setup, profile, template, onboarding workflow, etc.). You already did all of this.
  • Welcome message — The “Welcome to DESN368” intro paragraph. Replace it with your own intro.
  • Repository Structure section — This was the template’s generic structure. Your repo has evolved past this.
  • Need Help? and Ready to start? — These were onboarding prompts. No longer needed.

Keep these sections:

  • Student Information — Keep it, it’s useful context
  • My Toolkit — Keep it! Update any placeholder links you haven’t filled in yet
  • Course Progress — Keep the week checklist. Check off weeks you’ve completed.
  • Course Resources — Keep all of it. Add any resources you’ve found useful.
Step 2

Make It Yours

Now rewrite the top of the file. Replace the old welcome message with your own intro:

  1. A title — Your name, or a creative project title
  2. About — 2–3 sentences: Who are you? What is this repo? What are you learning?
  3. Week links — Update the Course Progress section to link each week to your week folders (we’ll make these clickable links once GitHub Pages is set up)
  4. Toolkit links — Fill in any placeholder links in My Toolkit that you haven’t updated yet

Example — what the top should look like

# Jordan Rivera — DESN 368 Portfolio

## About
I’m a graphic design student at EWU exploring web design and development.
This repo holds all my projects, exercises, and experiments from DESN 368.

## What’s Inside
- `week-1/` — Newspaper layout, Lost Pet flyer, Favorite Band page
- `week-2/` — HTML 101 exercises, Recipe page, HTML Skeleton
- `week-3/` — CSS foundations, Recipe styling

(keep Student Info, My Toolkit, Course Progress, and Course Resources below this)
Info

The Course Resources section is valuable — keep it and add to it! If you find a helpful tutorial, CSS reference, or design tool, add it there. Make this README a living document.

Step 3

Commit Your README

Same workflow you learned in the Setup Lab:

  1. Open the Source Control panel (Ctrl+Shift+G / Cmd+Shift+G)
  2. Click the + next to README.md to stage it
  3. Type your commit message: Update README — make it mine
  4. Click the checkmark (✓) to commit
  5. Click Sync Changes to push to GitHub
Done When

Your GitHub repo shows YOUR README when someone visits the main page — not the course template.

Submission

Submit your GitHub repo URL. Your README should be visible on the main repo page.