How corkami/pics works
Project Type and Purpose
• Type: A static content repository organized into four primary “collections” (binary posters, posters, tracings, outlines).
• Purpose: Host and distribute PDFs, images, code examples, and build artifacts as educational/reference materials via GitHub (and optionally GitHub Pages).
File Structure
• Top-level directories:
– binary/ ← “Binary posters” with subfolders for formats, examples, and per‐format readme.
– posters/ ← 25 curated posters, grouped in subfolders.
– tracing/ ← 59 tracings in PDF/TEX and image form.
– outline/ ← 9 hardware/system outlines.
• Configuration:
– README.md at root links into each collection’s README.
– .github/FUNDING.yml for sponsor metadata.
• Build‐related files (in subfolders only):
– Makefiles in some binary/* examples.
– parse.py in wav101.
• No server-side code or database—purely static content.
README for Additional Insights
• The root README provides a gallery overview and links to sub-collection READMEs.
• Each collection README includes thumbnails and navigation hints.
• No explicit “build” or “deployment” instructions—assume GitHub Pages or equivalent static‐site host.
Main Components and Interactions
a. Developer Workstation
– Clones or forks the Git repo.
– Runs any local build tools (Make, Python script) to regenerate examples in binary/*.
– Commits new or updated content.
b. Git Repository (Origin)
– Stores all Markdown, PDF, image assets, and build scripts.
c. Continuous Deployment (optional)
– GitHub Pages or CDN pulls updates from the main branch.
– Generates a static website for browsing galleries and downloading assets.
d. End-User Browser
– Requests HTML (via GitHub Pages).
– Fetches static assets (PDFs, PNGs, etc.) directly from the same origin or CDN.
Architectural Patterns and Principles
• Content Modularity: Each collection lives in its own folder with its own README and assets.
• Static-First: No runtime application servers—everything is served statically.
• Build as Code: Where needed, simple Makefiles/Python scripts regenerate demonstration files.
• GitOps Deployment: Changes to content automatically flow through Git to the public site.