Skip to content

QUICKSTART.md

Latest commit

 

History

History
97 lines (69 loc) · 2.72 KB

QUICKSTART.md

File metadata and controls

97 lines (69 loc) · 2.72 KB
Raw

Quick Start Guide for Instructors

Using This Repository with GitHub Classroom

Step 1: Create Your GitHub Classroom Assignment

  1. Go to GitHub Classroom
  2. Select your classroom or create a new one
  3. Click "New Assignment"
  4. Choose "Individual Assignment"
  5. Name it: "Git Installation Assignment" (or your preferred name)
  6. Select this repository as the starter code
  7. Set your deadline
  8. Enable "Grant students admin access to their repository"
  9. Click "Create Assignment"

Step 2: Share with Students

  1. Copy the assignment invitation link
  2. Share it with your students via:
    • Learning Management System (Canvas, Blackboard, Moodle, etc.)
    • Email
    • Course website
    • Announcement

Step 3: Monitor Submissions

Students will need to:

  1. Accept the assignment (creates their repository)
  2. Clone the repository to their local machine
  3. Follow the README.md instructions
  4. Add their screenshot to the screenshots/ folder
  5. Fill out SUBMISSION.md
  6. Commit and push their changes

Step 4: Grade Submissions

Review the INSTRUCTOR_NOTES.md file for detailed grading guidelines.

Quick checklist for each student:

  • Screenshot exists in screenshots/ folder
  • Screenshot shows Git Bash/Terminal with whoami command
  • SUBMISSION.md is filled out (not just template)
  • Files are properly named
  • Changes are committed and pushed

Expected Timeline

Typical student completion time: 30-60 minutes

  • 15-30 min: Download and install Git
  • 5-10 min: Verify installation and run commands
  • 5-10 min: Take screenshot and fill out submission form
  • 5-10 min: Commit and push changes

Common Questions from Students

"Do I need to install Git if I already have it?" → No, but they still need to complete the verification steps and submit the screenshot

"Can I use GitHub Desktop instead?" → For this assignment, they should use command-line Git and Git Bash

"The whoami command doesn't work" → Make sure they're using Git Bash (Windows), not Command Prompt

"I can't push my changes" → Check they've properly cloned their assignment repository from GitHub Classroom

Tips for Success

✅ Do:

  • Give students at least a week to complete
  • Test the assignment yourself first
  • Provide office hours for technical support
  • Share the assignment early in the semester

❌ Don't:

  • Assume all students have prior command-line experience
  • Make this a graded assignment if students don't have computer access
  • Skip the demonstration in class

Need Help?

  • Review INSTRUCTOR_NOTES.md for comprehensive details
  • Check README.md to see what students see
  • Test the assignment in your own environment

Happy teaching! 📚