init git by example book

Author: dariubs

.github/workflows/build-pdf.yml

@@ -0,0 +1,75 @@
+name: Build PDF
+
+on:
+  push:
+    branches: [main]
+
+permissions:
+  contents: write
+
+jobs:
+  build-pdf:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: pip install reportlab markdown beautifulsoup4 Pygments
+
+      - name: Get short commit hash
+        id: vars
+        run: echo "short_sha=$(git rev-parse --short=6 HEAD)" >> "$GITHUB_OUTPUT"
+
+      - name: Build PDF
+        run: python scripts/build_pdf.py "gitbyexample-${{ steps.vars.outputs.short_sha }}.pdf"
+
+      - name: Publish to pdf branch
+        run: |
+          PDF_FILE="gitbyexample-${{ steps.vars.outputs.short_sha }}.pdf"
+
+          # Save the PDF outside the working tree
+          cp "$PDF_FILE" /tmp/"$PDF_FILE"
+
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+          # Switch to pdf branch (fetch existing or create orphan)
+          if git ls-remote --heads origin pdf | grep -q pdf; then
+            git fetch origin pdf
+            git checkout pdf
+          else
+            git checkout --orphan pdf
+            git rm -rf . 2>/dev/null || true
+            git clean -fd
+          fi
+
+          # Copy the new PDF in
+          cp /tmp/"$PDF_FILE" .
+
+          # Clean old PDFs, keep last 10
+          ls -t gitbyexample-*.pdf 2>/dev/null | tail -n +11 | xargs -r rm -f
+
+          # Write README for the pdf branch
+          cat > README.md << 'EOF'
+          # Git By Example — PDF Builds
+
+          This branch contains auto-generated PDF builds of the book.
+
+          Each push to `main` produces a new PDF named `gitbyexample-<commit>.pdf`.
+
+          📥 **Download the latest**: check the most recent file below.
+          EOF
+          sed -i 's/^          //' README.md
+
+          git add README.md gitbyexample-*.pdf
+          git commit -m "pdf: build from ${GITHUB_SHA::6}" || echo "No changes to commit"
+          git push origin pdf

01-getting-started.md

@@ -0,0 +1,136 @@
+# Chapter 1 — Getting Started
+
+## Installing Git
+
+### macOS
+
+```bash
+# Option 1: Xcode Command Line Tools (easiest)
+xcode-select --install
+
+# Option 2: Homebrew
+brew install git
+```
+
+### Linux (Debian/Ubuntu)
+
+```bash
+sudo apt update
+sudo apt install git
+```
+
+### Linux (Fedora)
+
+```bash
+sudo dnf install git
+```
+
+### Windows
+
+Download the installer from [git-scm.com](https://git-scm.com/download/win), or use:
+
+```powershell
+winget install Git.Git
+```
+
+### Verify Installation
+
+```bash
+git --version
+```
+
+```
+git version 2.44.0
+```
+
+## Configuring Git
+
+Before your first commit, tell Git who you are.
+
+### Example: Set your identity
+
+```bash
+git config --global user.name "Dariush Abbasi"
+git config --global user.email "dariush@example.com"
+```
+
+🧠 **What happened?** Git wrote these values to `~/.gitconfig`. Every commit you make will be stamped with this name and email.
+
+### Example: See your config
+
+```bash
+git config --list
+```
+
+```
+user.name=Dariush Abbasi
+user.email=dariush@example.com
+```
+
+### Example: Set your default editor
+
+```bash
+git config --global core.editor "vim"
+```
+
+Other popular choices: `"code --wait"` (VS Code), `"nano"`, `"subl -n -w"` (Sublime Text).
+
+### Example: Set default branch name
+
+```bash
+git config --global init.defaultBranch main
+```
+
+🧠 **What happened?** New repositories you create with `git init` will use `main` instead of `master` as the default branch name.
+
+## Creating Your First Repository
+
+### Example: Initialize a new repo
+
+```bash
+mkdir my-project
+cd my-project
+git init
+```
+
+```
+Initialized empty Git repository in /home/you/my-project/.git/
+```
+
+### Example: See what Git created
+
+```bash
+ls -la .git/
+```
+
+```
+drwxr-xr-x  HEAD
+drwxr-xr-x  config
+drwxr-xr-x  hooks/
+drwxr-xr-x  objects/
+drwxr-xr-x  refs/
+```
+
+🧠 **What happened?** Git created a hidden `.git/` directory. This single folder *is* your repository — all history, branches, and configuration live inside it. Your working directory is just a checkout of one version.
+
+## Cloning an Existing Repository
+
+### Example: Clone a repo from GitHub
+
+```bash
+git clone https://github.com/boringcollege/git-by-example.git
+cd git-by-example
+```
+
+```
+Cloning into 'git-by-example'...
+remote: Enumerating objects: 42, done.
+remote: Total 42 (delta 0), reused 0 (delta 0)
+Receiving objects: 100% (42/42), done.
+```
+
+🧠 **What happened?** Git downloaded the entire repository — all files, all branches, all history — to your machine. You now have a full, independent copy.
+
+---
+
+[Next: Chapter 2 — The Basics →](02-the-basics.md)