Tighten prose punctuation across READMEs
Reduce colon overuse and tighten em-dash phrasing for readability. Add .gitignore for devlog and CHANGES.
This commit is contained in:
Eric Furst
parent
8d29a3a42b
commit
36d4fda5aa
6 changed files with 65 additions and 61 deletions
|
|
@ -15,7 +15,7 @@ Install git, configure your identity, and use it to download and stay current wi
|
|||
|
||||
This module is **pull-focused**. Authentication, pushing your own commits, branching, and merging belong in a later module on git collaboration. For now, the goal is to *receive* updates reliably.
|
||||
|
||||
> **Windows users:** install WSL before starting this module — see [../WSL.md](../WSL.md). All commands below assume a Unix-style terminal (macOS, Linux, or WSL).
|
||||
> **Windows users:** install WSL before starting this module. See [../WSL.md](../WSL.md). All commands below assume a Unix-style terminal (macOS, Linux, or WSL).
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -23,7 +23,7 @@ This module is **pull-focused**. Authentication, pushing your own commits, branc
|
|||
|
||||
Git is a **version control** system. It tracks changes to files over time, lets you go back to earlier states, and lets many people work on the same files without overwriting each other.
|
||||
|
||||
A **repository** (often "repo") is a folder that git is tracking. Public repositories on hosting services like [Gitea](https://about.gitea.com/), GitHub, or GitLab can be downloaded ("cloned") by anyone — no account needed.
|
||||
A **repository** (often "repo") is a folder that git is tracking. Public repositories on hosting services like [Gitea](https://about.gitea.com/), GitHub, or GitLab can be downloaded ("cloned") by anyone. No account needed.
|
||||
|
||||
For now we will use git only to *download* materials and *keep them up to date*. You will not need to push anything back, and you do not need an account on any hosting service.
|
||||
|
||||
|
|
@ -59,14 +59,14 @@ For other Linux distributions, use the appropriate package manager (`dnf install
|
|||
git --version
|
||||
```
|
||||
|
||||
You should see something like `git version 2.40.1`. If the command is not found, the install did not finish — try again.
|
||||
You should see something like `git version 2.40.1`. If the command is not found, the install did not finish. Try again.
|
||||
|
||||
> **Tip (WSL users):** Run all git commands from inside your Linux home directory (e.g., `~/repos`), not from `/mnt/c/...`. Mixing Windows-side and WSL-side git on the same folder leads to permission and line-ending headaches.
|
||||
|
||||
|
||||
## 2. Configure your identity
|
||||
|
||||
Git stamps every commit with a name and email. Set yours once — these are labels on your local commits and do not need to match any account on a hosting service.
|
||||
Git stamps every commit with a name and email. Set yours once. These are labels on your local commits and do not need to match any account on a hosting service.
|
||||
|
||||
```bash
|
||||
git config --global user.name "Your Name"
|
||||
|
|
@ -104,7 +104,7 @@ This creates a folder named `cli-walkthrough` in your current directory. Move in
|
|||
cd cli-walkthrough
|
||||
```
|
||||
|
||||
> **Tip:** Be intentional about *where* you clone. Many people keep all their repos under one directory, e.g., `~/repos` or `~/code`. Avoid cloning into folders synced by Dropbox, iCloud, or OneDrive — sync conflicts and git history do not mix well.
|
||||
> **Tip:** Be intentional about *where* you clone. Many people keep all their repos under one directory, e.g., `~/repos` or `~/code`. Avoid cloning into folders synced by Dropbox, iCloud, or OneDrive. Sync conflicts and git history do not mix well.
|
||||
|
||||
|
||||
## 4. Check the state of a repository
|
||||
|
|
@ -117,7 +117,7 @@ git status
|
|||
|
||||
If you have not edited anything, you will see "nothing to commit, working tree clean." If you have edited files, git lists them.
|
||||
|
||||
`git status` is non-destructive. Run it whenever you are unsure what state things are in. It is the single most useful git command.
|
||||
`git status` is non-destructive. Run it whenever you are unsure what state things are in. It is the most useful git command.
|
||||
|
||||
|
||||
## 5. Pull updates
|
||||
|
|
@ -132,9 +132,9 @@ Run this from inside the repo (the folder you `cd`'d into after cloning).
|
|||
|
||||
**`git pull` does not silently overwrite your work.**
|
||||
|
||||
- If you have made no local changes → files update normally.
|
||||
- If you have local changes that don't conflict with incoming changes → git merges them automatically.
|
||||
- If there is a conflict → git **stops** and tells you exactly which files need attention. Your work is preserved.
|
||||
- If you have made no local changes, files update normally.
|
||||
- If your local changes don't conflict with the incoming ones, git merges them automatically.
|
||||
- If there is a conflict, git stops and tells you exactly which files need attention. Your work is preserved.
|
||||
|
||||
Get in the habit of running `git pull` before you start working in a shared repo, so you start from the latest version.
|
||||
|
||||
|
|
@ -157,7 +157,7 @@ This is also useful right before pulling updates — see section 7.
|
|||
|
||||
Sometimes git declines to pull because you have uncommitted changes that overlap with incoming updates. Two safe ways out:
|
||||
|
||||
### Option A — Commit your work first
|
||||
### Option A: Commit your work first
|
||||
|
||||
```bash
|
||||
git add .
|
||||
|
|
@ -165,7 +165,7 @@ git commit -m "save before pull"
|
|||
git pull
|
||||
```
|
||||
|
||||
### Option B — Temporarily set work aside
|
||||
### Option B: Temporarily set work aside
|
||||
|
||||
```bash
|
||||
git stash
|
||||
|
|
@ -191,7 +191,7 @@ Do not run them unless you understand exactly what they do and have intentionall
|
|||
|
||||
## 9. If something looks wrong
|
||||
|
||||
First, do not panic. Git is conservative — it does not overwrite committed work without a clear instruction. Most "something is wrong" situations are recoverable.
|
||||
First, do not panic. Git is conservative. It does not overwrite committed work without a clear instruction. Most "something is wrong" situations are recoverable.
|
||||
|
||||
Run:
|
||||
|
||||
|
|
@ -210,7 +210,7 @@ Anonymous cloning and pulling work for **public** repositories. You will need au
|
|||
- Clone or pull from a **private** repository
|
||||
- Use collaboration features (branches, pull requests, etc.)
|
||||
|
||||
Those topics — personal access tokens, SSH keys, branching, merging, pushing — are the subject of a follow-on module on git collaboration. For now, pull is enough.
|
||||
Those topics (personal access tokens, SSH keys, branching, merging, pushing) are the subject of a follow-on module on git collaboration. For now, pull is enough.
|
||||
|
||||
|
||||
## Exercises
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue