update readme
This commit is contained in:
Heerko
parent
ed6678f71e
commit
ca6954b2a5
|
|
@ -1,8 +1,5 @@
|
|||
# Soilpunk - Joulethief
|
||||
|
||||
## [View the slides here](https://hackersanddesigners.github.io/soilpunk_joulethief_slides/html_output/index.html) or the [plain text document here](https://github.com/hackersanddesigners/soilpunk_joulethief_slides/blob/master/slides.rst)
|
||||
|
||||
----
|
||||
Braids - Git workshop slides
|
||||
============================
|
||||
|
||||
The slides are generated from a .rst by [Hovercraft](https://github.com/regebro/hovercraft).
|
||||
- [Docs](https://hovercraft.readthedocs.io/en/latest/presentations.html#)
|
||||
|
|
|
|||
|
|
@ -1,7 +1,29 @@
|
|||
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"><head><title>Soilpunk Joulethief</title><meta charset="UTF-8"></meta><meta name="generator" content="Hovercraft! 1.0 http://regebro.github.com/hovercraft"></meta><meta name="author" content="Heerko van der Kooij"></meta><link rel="stylesheet" href="css/hovercraft.css" media="all"></link><link rel="stylesheet" href="css/highlight.css" media="all"></link><link rel="stylesheet" href="slides.css" media="screen,projection"></link><script type="text/x-mathjax-config">
|
||||
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"><head><title>Braids - Intro to Git</title><meta charset="UTF-8"></meta><meta name="generator" content="Hovercraft! 1.0 http://regebro.github.com/hovercraft"></meta><meta name="author" content="H&D"></meta><link rel="stylesheet" href="css/hovercraft.css" media="all"></link><link rel="stylesheet" href="css/highlight.css" media="all"></link><link rel="stylesheet" href="slides.css" media="screen,projection"></link><script type="text/x-mathjax-config">
|
||||
MathJax.Hub.Config({
|
||||
showProcessingMessages: false,
|
||||
messageStyle: "none",
|
||||
TeX : { extensions : ['color.js'] }
|
||||
});
|
||||
</script></head><body class="impress-not-supported"><div id="impress-help"></div><div class="header"><p>Soilpunk 🌏🤘 - Joulethief</p></div><div id="impress"><div class="step step-level-1" step="0" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="0" data-y="0" data-z="0"><h1 id="soilpunk-joulethief">Soilpunk - Joulethief</h1><p>This document is viewable as <a href="https://github.com/hackersanddesigners/soilpunk_joulethief_slides/blob/master/slides.rst">a webpage</a> or as <a href="https://hackersanddesigners.github.io/soilpunk_joulethief_slides/html_output/index.html">a slideshow</a></p></div><div class="step step-level-1" step="1" id="joulethief" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="1600" data-y="0" data-z="0"><h1 id="joulethief">Joulethief</h1><img src="./assets/images/joulethief_simple.jpeg"></img></div><div class="step step-level-1" step="2" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="3200" data-y="0" data-z="0"><h1 id="transistor">Transistor</h1><img src="./assets/images/transistor.png" width="300"></img><img src="./assets/images/analogi-transistor-87050130.gif" width="500"></img><p>Water analogy: the little bit of water from B to E opens the gate for the bigger flow from C to E</p></div><div class="step step-level-1" step="3" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="4800" data-y="0" data-z="0"><h1 id="joulethief-1">Joulethief</h1><img src="./assets/images/joulethief.jpeg"></img></div><div class="step step-level-1" step="4" id="joulethief-step1" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="6400" data-y="0" data-z="0"><h1 id="joulethief-2">Joulethief</h1><img src="./assets/images/joulethief_1.png"></img><p>A small current flows from the battery through the coil and the base-emitter path of the transistor. This opens the emittor-collector path of the transistor.</p></div><div class="step step-level-1" step="5" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="8000" data-y="0" data-z="0"><h1 id="joulethief-3">Joulethief</h1><img src="./assets/images/joulethief_2.png"></img><p>Electricity is now able to travel through the second coil and through the collector-emitter channel of the transistor.</p></div><div class="step step-level-1" step="6" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="9600" data-y="0" data-z="0"><h1 id="joulethief-4">Joulethief</h1><img src="./assets/images/joulethief_3.png"></img><p>The increasing amount of electricity through the second coil generates a negative voltage in the first coil, which cause the transistor to close.</p></div><div class="step step-level-1" step="7" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="11200" data-y="0" data-z="0"><h1 id="joulethief-5">Joulethief</h1><img src="./assets/images/joulethief_4.png"></img><p>With the transistor closed the energy starts to flow through the output (led).</p></div><div class="step step-level-1" step="8" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="12800" data-y="0" data-z="0"><h1 id="joulethief-6">Joulethief</h1><img src="./assets/images/joulethief_5.png"></img><p>The inductor is now powered by the magnetic field of the coil.</p></div><div class="step step-level-1" step="9" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="14400" data-y="0" data-z="0"><h1 id="joulethief-7">Joulethief</h1><img src="./assets/images/joulethief_6.png"></img><p>When the magnetic field is gone, the whole process <a href="#joulethief-step1">starts over</a>.</p></div><div class="step step-level-1" step="10" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="16000" data-y="0" data-z="0"><h1 id="joulethief-8">Joulethief</h1><p>A more detailed explanation can be found on <a href="https://www.instructables.com/Joule-Thief-Circuit-How-to-Make-and-Circuit-Explan/">instructables</a></p></div><div class="step step-level-1" step="11" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="17600" data-y="0" data-z="0"><h1 id="led">Led</h1><img src="./assets/images/led_polarity.png"></img><p>Make sure to get the LED polarity right. Short leg goes to ground!</p></div><div class="step step-level-1" step="12" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="19200" data-y="0" data-z="0"><h1 id="circuit">Circuit</h1><img src="./assets/images/circuit.png"></img><p><a href="https://github.com/hackersanddesigners/Soilpunk_joulethief">https://github.com/hackersanddesigners/Soilpunk_joulethief</a></p></div></div><script type="text/javascript" src="js/impress.js"></script><script type="text/javascript" src="js/gotoSlide.js"></script><script type="text/javascript" src="js/hovercraft.js"></script></body></html>
|
||||
</script></head><body class="impress-not-supported"><div id="impress-help"></div><div class="header"><p>Braids - Intro to Git</p></div><div id="impress"><div class="step step-level-1" step="0" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="0" data-y="0" data-z="0"><h1 id="braids-intro-to-git">Braids - Intro to Git</h1><div class="notes"><p>Goal: introduce Git as an archiving practice (history, provenance, selection),
|
||||
then do a playful branch-based website exercise published live.</p></div></div><div class="step step-level-1" step="1" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="1600" data-y="0" data-z="0"><h1 id="agenda-90-min">Agenda (90 min)</h1><ol><li>Context: what Git is, what it does, who uses it (10 min)</li><li>Install + quick sanity check (10 min)</li><li>Core concepts + core commands (20 min)</li><li>Forgejo: accounts + clone/push permissions (10 min)</li><li>Exercise: branch a page, publish live, iterate (35 min)</li><li>Wrap-up: good practices + next steps (5 min)</li></ol></div><div class="step step-level-1" step="2" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="3200" data-y="0" data-z="0"><h1 id="what-is-git">What is Git</h1><ul><li>Distributed version control system</li><li>Tracks changes over time</li><li>Enables:
|
||||
- history (time)
|
||||
- collaboration (many authors)
|
||||
- experimentation (branches)
|
||||
- traceability (who/what/when/why)</li></ul><p>Archiving analogy:</p><ul><li>commit = deposit with metadata</li><li>log = inventory / finding aid</li><li>branch = parallel dossier / alternative interpretation</li></ul></div><div class="step step-level-1" step="3" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="4800" data-y="0" data-z="0"><h1 id="what-git-is-not">What Git is not</h1><ul><li>Not a backup system (though it can help)</li><li>Not a file sync tool</li><li>Not a CMS</li><li>Not magic: it stores snapshots + metadata, you still choose what to record</li></ul></div><div class="step step-level-1" step="4" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="6400" data-y="0" data-z="0"><h1 id="ecosystem">Ecosystem</h1><ul><li>Git = the tool + file format</li><li>Hosting platforms:
|
||||
- GitHub, GitLab, Bitbucket
|
||||
- Forgejo / Gitea (self-hosted)</li></ul></div><div class="step step-level-1" step="5" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="8000" data-y="0" data-z="0"><h1 id="typical-workflow">Typical workflow</h1><ul><li>remote (server copy)</li><li>clone (get a copy)</li><li>push (send your commits back to the server)</li><li>pull/fetch (receive updates)</li></ul></div><div class="step step-level-1" step="6" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="9600" data-y="0" data-z="0"><h1 id="workshop-outcome">Workshop outcome</h1><p>Each participant will:</p><ul><li>clone a repo</li><li>create a branch</li><li>edit a simple profile website</li><li>commit changes with a clear message</li><li>push branch to Forgejo</li><li>see it appear in the live gallery</li></ul></div><div class="step step-level-1" step="7" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="11200" data-y="0" data-z="0"><h1 id="install-git">Install Git</h1><p>Check first:</p><pre class="highlight code bash">git<span class="w"> </span>--version</pre><p>If missing:</p><ul><li>macOS: Xcode Command Line Tools</li><li>Windows: Git for Windows</li><li>Linux: package manager (apt/dnf/pacman)</li></ul><p>Minimum requirement: you can run git in a terminal.</p></div><div class="step step-level-1" step="8" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="12800" data-y="0" data-z="0"><h1 id="configure-identity-once">Configure identity (once)</h1><pre class="highlight code bash">git<span class="w"> </span>config<span class="w"> </span>--global<span class="w"> </span>user.name<span class="w"> </span><span class="s2">"Your Name"</span><span class="w">
|
||||
</span>git<span class="w"> </span>config<span class="w"> </span>--global<span class="w"> </span>user.email<span class="w"> </span><span class="s2">"you@example.com"</span></pre><p>Check:</p><pre class="highlight code bash">git<span class="w"> </span>config<span class="w"> </span>--global<span class="w"> </span>--list</pre><div class="notes"><p>This shows up in commit metadata (provenance).</p></div></div><div class="step step-level-1" step="9" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="14400" data-y="0" data-z="0"><h1 id="core-concept-three-areas">Core concept: three areas</h1><ol><li>Working tree: your files right now</li><li>Staging area (index): selection for the next deposit</li><li>Repository history: commits (deposits)</li></ol><p>This is why Git feels "archival":</p><ul><li>you intentionally select what becomes part of the record.</li></ul></div><div class="step step-level-1" step="10" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="16000" data-y="0" data-z="0"><h1 id="commands-the-essential-set">Commands: the essential set</h1><ul><li>git status (always)</li><li>git init (initalise a repo)</li><li>git commit (store changes in the repo)</li><li>git add (add files to the commit)</li><li>git branch (take a detour)</li><li>git merge (merge branches)</li><li>git checkout (get the repo at a specific state)</li><li>git fetch (sync with a repo online)</li><li>git pull (sync with a repo online and merge)</li><li>git diff (what changed)</li><li>git log (history)</li><li>plus: log, diff</li></ul></div><div class="step step-level-1" step="11" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="17600" data-y="0" data-z="0"><h1 id="command-git-init">Command: git init</h1><p>Create a repository in the current folder.</p><pre class="highlight code bash">git<span class="w"> </span>init</pre><p>Creates a .git/ directory containing history + metadata.</p><div class="notes"><p>For the exercise we will use git clone instead of git init.</p></div></div><div class="step step-level-1" step="12" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="19200" data-y="0" data-z="0"><h1 id="command-git-clone">Command: git clone</h1><p>Cloen (copy) a repository in the current folder.</p><pre class="highlight code bash">git<span class="w"> </span>clone<span class="w"> </span><repo_url><span class="w"> </span><destination></pre><p>Downloads a repo from the web, complete with the full commit history and all changes.</p></div><div class="step step-level-1" step="13" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="20800" data-y="0" data-z="0"><h1 id="command-git-status-your-dashboard">Command: git status (your dashboard)</h1><pre class="highlight code bash">git<span class="w"> </span>status</pre><p>Shows:</p><ul><li>current branch</li><li>staged vs unstaged changes</li><li>untracked files</li></ul></div><div class="step step-level-1" step="14" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="22400" data-y="0" data-z="0"><h1 id="command-git-add-select-files">Command: git add (select files)</h1><p>Stage files for the next commit.</p><pre class="highlight code bash">git<span class="w"> </span>add<span class="w"> </span>index.html<span class="w">
|
||||
</span>git<span class="w"> </span>add<span class="w"> </span>assets/</pre><p>Stage everything (use carefully):</p><pre class="highlight code bash">git<span class="w"> </span>add<span class="w"> </span>.</pre><div class="notes"><p>Staging is curatorial: select what belongs together.</p></div></div><div class="step step-level-1" step="15" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="24000" data-y="0" data-z="0"><h1 id="command-git-commit">Command: git commit</h1><pre class="highlight code bash">git<span class="w"> </span>commit<span class="w"> </span>-m<span class="w"> </span><span class="s2">"Added name to my page"</span></pre><p>Good commit message pattern:</p><ul><li>What changed</li><li>Why it changed (reason/intent)</li><li>Scope stays small</li></ul></div><div class="step step-level-1" step="16" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="25600" data-y="0" data-z="0"><h1 id="command-git-diff-what-changed">Command: git diff (what changed)</h1><p>Unstaged changes:</p><pre class="highlight code bash">git<span class="w"> </span>diff</pre><p>Staged changes:</p><pre class="highlight code bash">git<span class="w"> </span>diff<span class="w"> </span>--staged</pre></div><div class="step step-level-1" step="17" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="27200" data-y="0" data-z="0"><h1 id="command-git-log-inventory">Command: git log (inventory)</h1><pre class="highlight code bash">git<span class="w"> </span>log<span class="w"> </span>--oneline<span class="w"> </span>--graph</pre><p>Gives a quick "finding aid" of earlier commits. Press 'q' to exit.</p></div><div class="step step-level-1" step="18" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="28800" data-y="0" data-z="0"><h1 id="command-git-branch-and-git-checkout">Command: git branch and git checkout</h1><p>List branches:</p><pre class="highlight code bash">git<span class="w"> </span>branch</pre><p>Create a branch:</p><pre class="highlight code bash">git<span class="w"> </span>branch<span class="w"> </span>people/yourname</pre><p>Switch to branch:</p><pre class="highlight code bash">git<span class="w"> </span>checkout<span class="w"> </span>people/yourname</pre><p>Shortcut (create + switch):</p><pre class="highlight code bash">git<span class="w"> </span>checkout<span class="w"> </span>-b<span class="w"> </span>people/yourname</pre><div class="notes"><p>Branches are parallel dossiers: safe space for changes.</p></div></div><div class="step step-level-1" step="19" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="30400" data-y="0" data-z="0"><h1 id="command-git-push-git-pull">Command: git push / git pull</h1><p>Push your branch to the server:</p><pre class="highlight code bash">git<span class="w"> </span>push<span class="w"> </span>-u<span class="w"> </span>origin<span class="w"> </span>people/yourname</pre><p>Pull updates from server:</p><pre class="highlight code bash">git<span class="w"> </span>pull</pre><div class="notes"><p>During the exercise you mostly push your branch.
|
||||
Pull is mainly for getting new changes on main (if needed).</p></div></div><div class="step step-level-1" step="20" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="32000" data-y="0" data-z="0"><h1 id="optional-git-rm">Optional: git rm</h1><p>Remove a tracked file and stage the removal:</p><pre class="highlight code bash">git<span class="w"> </span>rm<span class="w"> </span>old.html<span class="w">
|
||||
</span>git<span class="w"> </span>commit<span class="w"> </span>-m<span class="w"> </span><span class="s2">"Remove old page"</span></pre><p>For this workshop you probably will not need it.</p></div><div class="step step-level-1" step="21" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="33600" data-y="0" data-z="0"><h1 id="forgejo-what-we-use-today">Forgejo: what we use today</h1><ul><li>Forgejo hosts the central repository (remote)</li><li>You will:
|
||||
- create an account
|
||||
- clone via HTTPS/SSH
|
||||
- push your branch</li></ul><p>Rules for today:</p><ul><li>do NOT push to main</li><li>create your branch under people/<slug></li></ul></div><div class="step step-level-1" step="22" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="35200" data-y="0" data-z="0"><h1 id="forgejo-account-setup">Forgejo: account setup</h1><ol><li>Create account at: git.<your-domain></li><li>Confirm you can sign in</li><li>Add SSH key (optional) OR use HTTPS credentials</li></ol><p>We will provide:</p><ul><li>repo URL</li><li>branch naming convention</li><li>live gallery URL: braids.<your-domain></li></ul></div><div class="step step-level-1" step="23" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="36800" data-y="0" data-z="0"><h1 id="exercise-overview">Exercise overview</h1><p>You will build a deliberately simple “MySpace-style” page:</p><ul><li>"Hi, I'm …"</li><li>one gif</li><li>one link</li><li>optional: background, glitter, bad taste encouraged</li></ul><p>Workflow loop:</p><p>clone -> branch -> edit -> status -> add -> commit -> push -> view -> iterate</p></div><div class="step step-level-1" step="24" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="38400" data-y="0" data-z="0"><h1 id="exercise-step-1-clone">Exercise: step 1 (clone)</h1><pre class="highlight code bash">git<span class="w"> </span>clone<span class="w"> </span><REPO_URL><span class="w">
|
||||
</span><span class="nb">cd</span><span class="w"> </span><REPO_NAME></pre><p>Sanity check:</p><pre class="highlight code bash">git<span class="w"> </span>status<span class="w">
|
||||
</span>git<span class="w"> </span>branch</pre></div><div class="step step-level-1" step="25" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="40000" data-y="0" data-z="0"><h1 id="exercise-step-2-create-your-branch">Exercise: step 2 (create your branch)</h1><p>Choose a slug: lowercase, no spaces. Example: people/alex.</p><pre class="highlight code bash">git<span class="w"> </span>checkout<span class="w"> </span>-b<span class="w"> </span>people/<your-slug></pre><p>Confirm:</p><pre class="highlight code bash">git<span class="w"> </span>status</pre></div><div class="step step-level-1" step="26" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="41600" data-y="0" data-z="0"><h1 id="exercise-step-3-edit-the-page">Exercise: step 3 (edit the page)</h1><p>Edit the root index.html (and optionally style.css, assets/).</p><p>Make a visible change first:</p><ul><li>your name</li><li>one gif</li><li>one link</li></ul><p>Then check changes:</p><pre class="highlight code bash">git<span class="w"> </span>diff<span class="w">
|
||||
</span>git<span class="w"> </span>status</pre></div><div class="step step-level-1" step="27" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="43200" data-y="0" data-z="0"><h1 id="exercise-step-4-stage-commit">Exercise: step 4 (stage + commit)</h1><pre class="highlight code bash">git<span class="w"> </span>add<span class="w"> </span>index.html<span class="w">
|
||||
</span>git<span class="w"> </span>commit<span class="w"> </span>-m<span class="w"> </span><span class="s2">"Customize profile page for <your-slug>"</span></pre><p>If you added assets:</p><pre class="highlight code bash">git<span class="w"> </span>add<span class="w"> </span>assets/<span class="w">
|
||||
</span>git<span class="w"> </span>commit<span class="w"> </span>-m<span class="w"> </span><span class="s2">"Add assets for <your-slug>"</span></pre><div class="notes"><p>Small commits win. One change = one deposit.</p></div></div><div class="step step-level-1" step="28" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="44800" data-y="0" data-z="0"><h1 id="exercise-step-5-push-your-branch">Exercise: step 5 (push your branch)</h1><pre class="highlight code bash">git<span class="w"> </span>push<span class="w"> </span>-u<span class="w"> </span>origin<span class="w"> </span>people/<your-slug></pre><p>If prompted for credentials, use your Forgejo login method.</p></div><div class="step step-level-1" step="29" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="46400" data-y="0" data-z="0"><h1 id="exercise-step-6-view-live">Exercise: step 6 (view live)</h1><p>Open the gallery:</p><ul><li>https://braids.<your-domain>/</li></ul><p>Find your card:</p><ul><li>people/<your-slug>/</li></ul><p>Iterate:</p><p>edit -> status -> add -> commit -> push -> refresh</p></div><div class="step step-level-1" step="30" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="48000" data-y="0" data-z="0"><h1 id="common-problems-fast-fixes">Common problems (fast fixes)</h1><p>Wrong branch:</p><pre class="highlight code bash">git<span class="w"> </span>branch<span class="w">
|
||||
</span>git<span class="w"> </span>checkout<span class="w"> </span>people/<your-slug></pre><p>Nothing staged:</p><pre class="highlight code bash">git<span class="w"> </span>status<span class="w">
|
||||
</span>git<span class="w"> </span>add<span class="w"> </span>index.html</pre><p>Push rejected (main protected):</p><ul><li>You are on main. Switch to your branch.</li></ul><p>Auth issues:</p><ul><li>HTTPS: check username/token/password</li><li>SSH: check key added to Forgejo + ssh -T</li></ul></div><div class="step step-level-1" step="31" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="49600" data-y="0" data-z="0"><h1 id="concept-recap-in-archiving-terms">Concept recap in archiving terms</h1><ul><li>commit = deposit (with minimal metadata)</li><li>log = inventory / chain of custody</li><li>diff = conservation report (what changed)</li><li>branch = parallel dossier</li><li>push = deposit to institutional archive (remote)</li></ul></div><div class="step step-level-1" step="32" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="51200" data-y="0" data-z="0"><h1 id="suggested-good-enough-commit-messages">Suggested “good enough” commit messages</h1><p>Bad:</p><ul><li>"update"</li><li>"stuff"</li><li>"changes"</li></ul><p>Better:</p><ul><li>"Add animated gif and profile link"</li><li>"Change background and typography"</li><li>"Fix broken image path"</li><li>"Refactor layout: move link block above gif"</li></ul><p>Rule: message should still make sense in 6 months.</p></div><div class="step step-level-1" step="33" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="52800" data-y="0" data-z="0"><h1 id="optional-extension-if-time-remains">Optional extension (if time remains)</h1><ul><li>Compare two branches visually (gallery view)</li><li>Add a second commit that intentionally breaks something,
|
||||
then fix it with a third commit</li><li>Show git log to narrate your work as a documented process</li></ul></div><div class="step step-level-1" step="34" data-rotate-x="0" data-rotate-y="0" data-rotate-z="0" data-scale="1" data-x="54400" data-y="0" data-z="0"><h1 id="wrap-up">Wrap-up</h1><p>You should now be able to:</p><ul><li>create a branch safely</li><li>record changes as commits</li><li>publish to a remote</li><li>read history and differences</li></ul><p>Next steps:</p><ul><li>merging via PRs (review workflow)</li><li>tags/releases (archival milestones)</li><li>basic collaboration patterns (feature branches)</li></ul><div class="notes"><p>End: remind participants their branches will be removed after the workshop.</p></div></div></div><script type="text/javascript" src="js/impress.js"></script><script type="text/javascript" src="js/gotoSlide.js"></script><script type="text/javascript" src="js/hovercraft.js"></script></body></html>
|
||||
|
|
@ -99,3 +99,10 @@ div#the-slide-id img{
|
|||
top: 0;
|
||||
left: 0;
|
||||
}
|
||||
|
||||
.bash {
|
||||
background-color: #eee;
|
||||
/* color: white; */
|
||||
padding: 1rem;
|
||||
border-radius: 1rem;
|
||||
}
|
||||
|
|
@ -99,3 +99,4 @@ div#the-slide-id img{
|
|||
top: 0;
|
||||
left: 0;
|
||||
}
|
||||
|
||||
|
|
|
|||
575
slides.rst
575
slides.rst
|
|
@ -1,123 +1,586 @@
|
|||
:title: Soilpunk Joulethief
|
||||
:author: Heerko van der Kooij
|
||||
:title: Braids - Intro to Git
|
||||
:author: H&D
|
||||
:description:
|
||||
:css: slides.css
|
||||
|
||||
.. header::
|
||||
|
||||
Soilpunk 🌏🤘 - Joulethief
|
||||
Braids - Intro to Git
|
||||
|
||||
----
|
||||
|
||||
Soilpunk - Joulethief
|
||||
Braids - Intro to Git
|
||||
=====================
|
||||
|
||||
.. note::
|
||||
|
||||
Goal: introduce Git as an archiving practice (history, provenance, selection),
|
||||
then do a playful branch-based website exercise published live.
|
||||
|
||||
----
|
||||
|
||||
Agenda (90 min)
|
||||
===============
|
||||
|
||||
1. Context: what Git is, what it does, who uses it (10 min)
|
||||
2. Install + quick sanity check (10 min)
|
||||
3. Core concepts + core commands (20 min)
|
||||
4. Forgejo: accounts + clone/push permissions (10 min)
|
||||
5. Exercise: branch a page, publish live, iterate (35 min)
|
||||
6. Wrap-up: good practices + next steps (5 min)
|
||||
|
||||
----
|
||||
|
||||
What is Git
|
||||
===========
|
||||
|
||||
- Distributed version control system
|
||||
- Tracks changes over time
|
||||
- Enables:
|
||||
- history (time)
|
||||
- collaboration (many authors)
|
||||
- experimentation (branches)
|
||||
- traceability (who/what/when/why)
|
||||
|
||||
Archiving analogy:
|
||||
|
||||
- commit = deposit with metadata
|
||||
- log = inventory / finding aid
|
||||
- branch = parallel dossier / alternative interpretation
|
||||
|
||||
----
|
||||
|
||||
What Git is not
|
||||
===============
|
||||
|
||||
- Not a backup system (though it can help)
|
||||
- Not a file sync tool
|
||||
- Not a CMS
|
||||
- Not magic: it stores snapshots + metadata, you still choose what to record
|
||||
|
||||
----
|
||||
|
||||
Ecosystem
|
||||
=========
|
||||
|
||||
- Git = the tool + file format
|
||||
- Hosting platforms:
|
||||
- GitHub, GitLab, Bitbucket
|
||||
- Forgejo / Gitea (self-hosted)
|
||||
|
||||
----
|
||||
|
||||
Typical workflow
|
||||
================
|
||||
|
||||
- remote (server copy)
|
||||
- clone (get a copy)
|
||||
- push (send your commits back to the server)
|
||||
- pull/fetch (receive updates)
|
||||
|
||||
----
|
||||
|
||||
Workshop outcome
|
||||
================
|
||||
|
||||
Each participant will:
|
||||
|
||||
- clone a repo
|
||||
- create a branch
|
||||
- edit a simple profile website
|
||||
- commit changes with a clear message
|
||||
- push branch to Forgejo
|
||||
- see it appear in the live gallery
|
||||
|
||||
----
|
||||
|
||||
Install Git
|
||||
===========
|
||||
|
||||
Check first:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git --version
|
||||
|
||||
If missing:
|
||||
|
||||
- macOS: Xcode Command Line Tools
|
||||
- Windows: Git for Windows
|
||||
- Linux: package manager (apt/dnf/pacman)
|
||||
|
||||
Minimum requirement: you can run `git` in a terminal.
|
||||
|
||||
----
|
||||
|
||||
Configure identity (once)
|
||||
=========================
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git config --global user.name "Your Name"
|
||||
git config --global user.email "you@example.com"
|
||||
|
||||
Check:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git config --global --list
|
||||
|
||||
.. note::
|
||||
|
||||
This shows up in commit metadata (provenance).
|
||||
|
||||
----
|
||||
|
||||
Core concept: three areas
|
||||
=========================
|
||||
|
||||
1. Working tree: your files right now
|
||||
2. Staging area (index): selection for the next deposit
|
||||
3. Repository history: commits (deposits)
|
||||
|
||||
This is why Git feels "archival":
|
||||
|
||||
- you intentionally select what becomes part of the record.
|
||||
|
||||
----
|
||||
|
||||
Commands: the essential set
|
||||
===========================
|
||||
|
||||
- `git status` (always)
|
||||
- `git init` (initalise a repo)
|
||||
- `git commit` (store changes in the repo)
|
||||
- `git add` (add files to the commit)
|
||||
- `git branch` (take a detour)
|
||||
- `git merge` (merge branches)
|
||||
- `git checkout` (get the repo at a specific state)
|
||||
- `git fetch` (sync with a repo online)
|
||||
- `git pull` (sync with a repo online and merge)
|
||||
|
||||
- `git diff` (what changed)
|
||||
- `git log` (history)
|
||||
|
||||
- plus: log, diff
|
||||
|
||||
----
|
||||
|
||||
Command: git init
|
||||
=================
|
||||
|
||||
Create a repository in the current folder.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git init
|
||||
|
||||
Creates a `.git/` directory containing history + metadata.
|
||||
|
||||
.. note::
|
||||
|
||||
For the exercise we will use `git clone` instead of `git init`.
|
||||
|
||||
|
||||
----
|
||||
|
||||
Command: git clone
|
||||
==================
|
||||
|
||||
Cloen (copy) a repository in the current folder.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git clone <repo_url> <destination>
|
||||
|
||||
Downloads a repo from the web, complete with the full commit history and all changes.
|
||||
|
||||
----
|
||||
|
||||
Command: git status (your dashboard)
|
||||
====================================
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git status
|
||||
|
||||
Shows:
|
||||
|
||||
- current branch
|
||||
- staged vs unstaged changes
|
||||
- untracked files
|
||||
|
||||
----
|
||||
|
||||
Command: git add (select files)
|
||||
===============================
|
||||
|
||||
Stage files for the next commit.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git add index.html
|
||||
git add assets/
|
||||
|
||||
Stage everything (use carefully):
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git add .
|
||||
|
||||
.. note::
|
||||
|
||||
Staging is curatorial: select what belongs together.
|
||||
|
||||
----
|
||||
|
||||
Command: git commit
|
||||
========================================
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git commit -m "Added name to my page"
|
||||
|
||||
Good commit message pattern:
|
||||
|
||||
- What changed
|
||||
- Why it changed (reason/intent)
|
||||
- Scope stays small
|
||||
|
||||
----
|
||||
|
||||
Command: git diff (what changed)
|
||||
================================
|
||||
|
||||
Unstaged changes:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git diff
|
||||
|
||||
Staged changes:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git diff --staged
|
||||
|
||||
----
|
||||
|
||||
Command: git log (inventory)
|
||||
============================
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git log --oneline --graph
|
||||
|
||||
Gives a quick "finding aid" of earlier commits. Press 'q' to exit.
|
||||
|
||||
----
|
||||
|
||||
Command: git branch and git checkout
|
||||
====================================
|
||||
|
||||
List branches:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git branch
|
||||
|
||||
Create a branch:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git branch people/yourname
|
||||
|
||||
Switch to branch:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git checkout people/yourname
|
||||
|
||||
Shortcut (create + switch):
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git checkout -b people/yourname
|
||||
|
||||
.. note::
|
||||
|
||||
Branches are parallel dossiers: safe space for changes.
|
||||
|
||||
----
|
||||
|
||||
Command: git push / git pull
|
||||
============================
|
||||
|
||||
Push your branch to the server:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git push -u origin people/yourname
|
||||
|
||||
Pull updates from server:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git pull
|
||||
|
||||
.. note::
|
||||
|
||||
During the exercise you mostly push your branch.
|
||||
Pull is mainly for getting new changes on main (if needed).
|
||||
|
||||
----
|
||||
|
||||
Optional: git rm
|
||||
================
|
||||
|
||||
Remove a tracked file and stage the removal:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git rm old.html
|
||||
git commit -m "Remove old page"
|
||||
|
||||
For this workshop you probably will not need it.
|
||||
|
||||
----
|
||||
|
||||
Forgejo: what we use today
|
||||
==========================
|
||||
|
||||
- Forgejo hosts the central repository (remote)
|
||||
- You will:
|
||||
- create an account
|
||||
- clone via HTTPS/SSH
|
||||
- push your branch
|
||||
|
||||
Rules for today:
|
||||
|
||||
- do NOT push to `main`
|
||||
- create your branch under `people/<slug>`
|
||||
|
||||
----
|
||||
|
||||
Forgejo: account setup
|
||||
======================
|
||||
|
||||
This document is viewable as `a webpage <https://github.com/hackersanddesigners/soilpunk_joulethief_slides/blob/master/slides.rst>`_ or as `a slideshow <https://hackersanddesigners.github.io/soilpunk_joulethief_slides/html_output/index.html>`_
|
||||
1. Create account at: `git.<your-domain>`
|
||||
2. Confirm you can sign in
|
||||
3. Add SSH key (optional) OR use HTTPS credentials
|
||||
|
||||
We will provide:
|
||||
|
||||
- repo URL
|
||||
- branch naming convention
|
||||
- live gallery URL: `braids.<your-domain>`
|
||||
|
||||
----
|
||||
|
||||
:id: joulethief
|
||||
Exercise overview
|
||||
=================
|
||||
|
||||
Joulethief
|
||||
You will build a deliberately simple “MySpace-style” page:
|
||||
|
||||
- "Hi, I'm …"
|
||||
- one gif
|
||||
- one link
|
||||
- optional: background, glitter, bad taste encouraged
|
||||
|
||||
Workflow loop:
|
||||
|
||||
clone -> branch -> edit -> status -> add -> commit -> push -> view -> iterate
|
||||
|
||||
----
|
||||
|
||||
Exercise: step 1 (clone)
|
||||
========================
|
||||
|
||||
.. image:: ./assets/images/joulethief_simple.jpeg
|
||||
.. code-block:: bash
|
||||
|
||||
git clone <REPO_URL>
|
||||
cd <REPO_NAME>
|
||||
|
||||
Sanity check:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git status
|
||||
git branch
|
||||
|
||||
----
|
||||
|
||||
Transistor
|
||||
==========
|
||||
Exercise: step 2 (create your branch)
|
||||
=====================================
|
||||
|
||||
.. image:: ./assets/images/transistor.png
|
||||
:width: 300
|
||||
.. image:: ./assets/images/analogi-transistor-87050130.gif
|
||||
:width: 500
|
||||
Choose a slug: lowercase, no spaces. Example: `people/alex`.
|
||||
|
||||
Water analogy: the little bit of water from B to E opens the gate for the bigger flow from C to E
|
||||
.. code-block:: bash
|
||||
|
||||
git checkout -b people/<your-slug>
|
||||
|
||||
Confirm:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git status
|
||||
|
||||
----
|
||||
|
||||
Joulethief
|
||||
========================
|
||||
Exercise: step 3 (edit the page)
|
||||
================================
|
||||
|
||||
.. image:: ./assets/images/joulethief.jpeg
|
||||
Edit the root `index.html` (and optionally `style.css`, `assets/`).
|
||||
|
||||
Make a visible change first:
|
||||
|
||||
- your name
|
||||
- one gif
|
||||
- one link
|
||||
|
||||
Then check changes:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git diff
|
||||
git status
|
||||
|
||||
----
|
||||
|
||||
:id: joulethief-step1
|
||||
Exercise: step 4 (stage + commit)
|
||||
=================================
|
||||
|
||||
Joulethief
|
||||
========================
|
||||
.. code-block:: bash
|
||||
|
||||
.. image:: ./assets/images/joulethief_1.png
|
||||
git add index.html
|
||||
git commit -m "Customize profile page for <your-slug>"
|
||||
|
||||
A small current flows from the battery through the coil and the base-emitter path of the transistor. This opens the emittor-collector path of the transistor.
|
||||
If you added assets:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git add assets/
|
||||
git commit -m "Add assets for <your-slug>"
|
||||
|
||||
.. note::
|
||||
|
||||
Small commits win. One change = one deposit.
|
||||
|
||||
----
|
||||
|
||||
Joulethief
|
||||
========================
|
||||
Exercise: step 5 (push your branch)
|
||||
===================================
|
||||
|
||||
.. image:: ./assets/images/joulethief_2.png
|
||||
.. code-block:: bash
|
||||
|
||||
Electricity is now able to travel through the second coil and through the collector-emitter channel of the transistor.
|
||||
git push -u origin people/<your-slug>
|
||||
|
||||
If prompted for credentials, use your Forgejo login method.
|
||||
|
||||
----
|
||||
|
||||
Joulethief
|
||||
========================
|
||||
Exercise: step 6 (view live)
|
||||
============================
|
||||
|
||||
.. image:: ./assets/images/joulethief_3.png
|
||||
Open the gallery:
|
||||
|
||||
The increasing amount of electricity through the second coil generates a negative voltage in the first coil, which cause the transistor to close.
|
||||
- `https://braids.<your-domain>/`
|
||||
|
||||
Find your card:
|
||||
|
||||
- `people/<your-slug>/`
|
||||
|
||||
Iterate:
|
||||
|
||||
edit -> status -> add -> commit -> push -> refresh
|
||||
|
||||
----
|
||||
|
||||
Joulethief
|
||||
========================
|
||||
Common problems (fast fixes)
|
||||
============================
|
||||
|
||||
.. image:: ./assets/images/joulethief_4.png
|
||||
Wrong branch:
|
||||
|
||||
With the transistor closed the energy starts to flow through the output (led).
|
||||
.. code-block:: bash
|
||||
|
||||
git branch
|
||||
git checkout people/<your-slug>
|
||||
|
||||
Nothing staged:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git status
|
||||
git add index.html
|
||||
|
||||
Push rejected (main protected):
|
||||
|
||||
- You are on `main`. Switch to your branch.
|
||||
|
||||
Auth issues:
|
||||
|
||||
- HTTPS: check username/token/password
|
||||
- SSH: check key added to Forgejo + `ssh -T`
|
||||
|
||||
----
|
||||
|
||||
Joulethief
|
||||
========================
|
||||
Concept recap in archiving terms
|
||||
================================
|
||||
|
||||
.. image:: ./assets/images/joulethief_5.png
|
||||
|
||||
The inductor is now powered by the magnetic field of the coil.
|
||||
- commit = deposit (with minimal metadata)
|
||||
- log = inventory / chain of custody
|
||||
- diff = conservation report (what changed)
|
||||
- branch = parallel dossier
|
||||
- push = deposit to institutional archive (remote)
|
||||
|
||||
----
|
||||
|
||||
Joulethief
|
||||
========================
|
||||
Suggested “good enough” commit messages
|
||||
=======================================
|
||||
|
||||
.. image:: ./assets/images/joulethief_6.png
|
||||
Bad:
|
||||
|
||||
When the magnetic field is gone, the whole process `starts over <#joulethief-step1>`_.
|
||||
- "update"
|
||||
- "stuff"
|
||||
- "changes"
|
||||
|
||||
Better:
|
||||
|
||||
- "Add animated gif and profile link"
|
||||
- "Change background and typography"
|
||||
- "Fix broken image path"
|
||||
- "Refactor layout: move link block above gif"
|
||||
|
||||
Rule: message should still make sense in 6 months.
|
||||
|
||||
----
|
||||
|
||||
Joulethief
|
||||
========================
|
||||
A more detailed explanation can be found on `instructables <https://www.instructables.com/Joule-Thief-Circuit-How-to-Make-and-Circuit-Explan/>`_
|
||||
Optional extension (if time remains)
|
||||
====================================
|
||||
|
||||
- Compare two branches visually (gallery view)
|
||||
- Add a second commit that intentionally breaks something,
|
||||
then fix it with a third commit
|
||||
- Show `git log` to narrate your work as a documented process
|
||||
|
||||
----
|
||||
|
||||
Led
|
||||
========================
|
||||
Wrap-up
|
||||
=======
|
||||
|
||||
.. image:: ./assets/images/led_polarity.png
|
||||
You should now be able to:
|
||||
|
||||
Make sure to get the LED polarity right. Short leg goes to ground!
|
||||
- create a branch safely
|
||||
- record changes as commits
|
||||
- publish to a remote
|
||||
- read history and differences
|
||||
|
||||
----
|
||||
Next steps:
|
||||
|
||||
Circuit
|
||||
========================
|
||||
- merging via PRs (review workflow)
|
||||
- tags/releases (archival milestones)
|
||||
- basic collaboration patterns (feature branches)
|
||||
|
||||
.. image:: ./assets/images/circuit.png
|
||||
.. note::
|
||||
|
||||
https://github.com/hackersanddesigners/Soilpunk_joulethief
|
||||
End: remind participants their branches will be removed after the workshop.
|
||||
Loading…
Reference in a new issue