floppydiscen/git-workshop
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

fix: cleanup README and focus on windows

Browse Source
This commit is contained in:
Bjarke Sporring
2026-01-12 08:42:20 +01:00
parent 5f78245734
commit 5492f17a5a
4 changed files with 365 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files

107
README.md
View File

@@ -36,7 +36,7 @@ Advanced Git workflows for power users:
### For Local Modules (01-08 in Essentials, all Advanced modules)
1. Navigate to a module directory (e.g., `01_essentials/01-basics`)
1. Navigate to a module directory (e.g., `01-essentials/01-basics`)
2. Read the `README.md` to understand the challenge
3. Run `./setup.ps1` to create the challenge environment
4. Complete the challenge using git commands
@@ -49,20 +49,18 @@ Advanced Git workflows for power users:
**This module is different!** It uses a real Git server for authentic collaboration:
1. Navigate to `01_essentials/08-multiplayer`
1. Navigate to `01-essentials/08-multiplayer`
2. Read the `README.md` for complete instructions
3. **No setup script** - you'll clone from https://git.frod.dk/multiplayer
4. Work with a partner on shared branches
5. Experience real merge conflicts and pull requests
6. **No verify script** - success is visual (your code appears in the final output)
**Facilitators**: See `01_essentials/08-multiplayer/FACILITATOR-SETUP.md` for server setup and workshop guidance.
**Facilitators**: See `01-essentials/08-multiplayer/FACILITATOR-SETUP.md` for server setup and workshop guidance.
## Running PowerShell Scripts
Most modules include setup, verification, and reset scripts. Here's how to run them:
### Windows
Most modules include setup, verification, and reset scripts.
If you encounter an "execution policy" error when running scripts, open PowerShell as Administrator and run:
@@ -73,76 +71,50 @@ Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
Then run scripts using:
```powershell
.\setup.ps1
.\verify.ps1
.\reset.ps1
```
### macOS/Linux
First, make sure scripts are executable (only needed once):
```bash
chmod +x 01_essentials/*/setup.ps1 01_essentials/*/verify.ps1 01_essentials/*/reset.ps1
chmod +x 02_advanced/*/setup.ps1 02_advanced/*/verify.ps1 02_advanced/*/reset.ps1
```
Then run scripts using:
```bash
./setup.ps1
```
Or explicitly with PowerShell:
```bash
pwsh setup.ps1
```
**Note:** All examples in this workshop use Windows syntax (`.\script.ps1`). macOS/Linux users should use `./script.ps1` instead.
## Requirements
### Git
### Installation
You need Git version 2.23 or later (for `git switch` and `git restore` commands).
**Windows 11 Users:** See [INSTALLATION.md](INSTALLATION.md) for complete step-by-step installation instructions including PowerShell 7, Git, and Visual Studio Code.
**Check if Git is installed:**
```powershell
git --version
```
**Quick Check:**
If you see a version number (e.g., "git version 2.34.1"), you're all set!
You need the following software installed:
If not, download and install from: https://git-scm.com/downloads
- **Git 2.23+** - Version control system
```powershell
git --version
```
**Configure Git (Required - First Time Only):**
- **PowerShell 7+**
```powershell
pwsh --version
```
Before making your first commit, tell Git who you are:
- **Python 3.6+** (for Module 08 only)
```powershell
python --version
```
**First-Time Git Configuration:**
Before making your first commit, configure Git with your identity:
```powershell
git config --global user.name "Your Name"
git config --global user.email "your.email@example.com"
```
**Verify your configuration:**
Verify your configuration:
```powershell
git config --global user.name
git config --global user.email
```
You should see your name and email printed. This is required to make commits in Git.
### PowerShell
- **Windows**: PowerShell 5.1+ (already included in Windows 10/11)
- **macOS/Linux**: Install PowerShell Core 7+ from https://github.com/PowerShell/PowerShell
**Check PowerShell version:**
```powershell
$PSVersionTable.PSVersion
```
### Python (for Module 08 only)
Module 08 (Multiplayer Git) uses Python:
- **Python 3.6+** required to run the Great Print Project
- Check: `python --version` or `python3 --version`
### Basic Command Line Knowledge
You should know how to:
@@ -163,11 +135,7 @@ This workshop includes many markdown files with instructions. You can install `g
After installation, read markdown files with:
```powershell
# Windows
.\bin\glow.exe README.md
# macOS/Linux
./bin/glow README.md
```
**Pro tip**: Use `glow -p` for pager mode on longer files!
@@ -194,10 +162,12 @@ Don't worry if these don't make sense yet - you'll learn them hands-on as you pr
## Getting Started
Start with Essentials Module 01:
**First time?** Make sure you have Git and PowerShell installed - see [INSTALLATION.md](INSTALLATION.md) for Windows 11 setup instructions.
Once installed, start with Essentials Module 01:
```powershell
cd 01_essentials/01-basics
cd 01-essentials\01-basics
.\setup.ps1
```
@@ -345,7 +315,7 @@ Run your own Git server with Gitea using Docker and Cloudflare Tunnel:
**Setup:**
1. See [GITEA-SETUP.md](GITEA-SETUP.md) for complete Gitea + Docker + Cloudflare Tunnel instructions
2. See `01_essentials/08-multiplayer/FACILITATOR-SETUP.md` for detailed workshop preparation:
2. See `01-essentials/08-multiplayer/FACILITATOR-SETUP.md` for detailed workshop preparation:
- Creating student accounts
- Setting up The Great Print Project repository
- Pairing students
@@ -369,13 +339,14 @@ You can also use existing cloud Git platforms:
```
git-workshop/
├── README.md # This file
├── INSTALLATION.md # Windows 11 installation guide (PowerShell 7, Git, VS Code)
├── GIT-CHEATSHEET.md # Quick reference for all Git commands
├── WORKSHOP-AGENDA.md # Facilitator guide for running workshops
├── PRESENTATION-OUTLINE.md # Slide deck outline
├── GITEA-SETUP.md # Self-hosted Git server setup
├── install-glow.ps1 # Install glow markdown renderer
│
├── 01_essentials/ # Core Git skills (8 modules)
├── 01-essentials/ # Core Git skills (8 modules)
│ ├── 01-basics/ # Initialize, commit, status
│ ├── 02-history/ # Log, diff, show
│ ├── 03-branching-and-merging/ # Branches, merging, conflicts (checkpoint-based)
@@ -387,7 +358,7 @@ git-workshop/
│ ├── README.md # Student guide
│ └── FACILITATOR-SETUP.md # Server setup guide
│
└── 02_advanced/ # Professional techniques (6 modules)
└── 02-advanced/ # Professional techniques (6 modules)
├── 01-rebasing/ # Linear history with rebase
├── 02-interactive-rebase/ # Clean up commits
├── 03-worktrees/ # Multiple branches simultaneously
@@ -468,10 +439,14 @@ This workshop is provided as-is for educational purposes.
---
**Ready to master Git? Start with Essentials Module 01 and begin your journey!**
**Ready to master Git?**
First-time setup (Windows 11): See [INSTALLATION.md](INSTALLATION.md)
Then start with Essentials Module 01 and begin your journey!
```powershell
cd 01_essentials/01-basics
cd 01-essentials\01-basics
.\setup.ps1
```