owlburtoe/TRS
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: add terminal + git clone steps to build instructions #3

Merged
owlburtoe merged 1 commit from docs/install-clone-step into main 2026-07-14 17:53:08 -04:00
Conversation 0 Commits 1 Files changed 1 +72 -17
owlburtoe commented 2026-07-14 17:49:37 -04:00
Owner
Copy link

What

The build-from-source path in #2 had a hole: it told you to install a toolchain and then run commands "from the folder containing this README" — but never said how to get that folder, or how to open a terminal in the first place. Someone who has never used a terminal was stuck before Step 1.

Adds to Part 2:

  • Step 1: open a terminal — how to launch PowerShell / Terminal on each OS, plus the two things that trip people up (paste keys differ; a password prompt shows no characters).
  • Step 3: download the code — git clone https://forgejo.owlburtoe.dev/owlburtoe/TRS.git, what "you are now inside the project folder" means, how to get back there later (cd ~/TRS), and git pull instead of re-cloning. Collapsed fallback for a browser Download ZIP with the drag-the-folder-onto-the-terminal trick for cd.
  • git is now installed alongside the other build tools (winget install --id Git.Git, apt/dnf/pacman install git; macOS gets it from the Xcode CLI tools) and is checked in the verify step.

Remaining steps renumbered (install tools → 2, verify → 4, build → 5, collect → 6), and the Develop section's link updated to the new anchor.

Test plan

  • Rendered README on Forgejo: anchors resolve, <details> blocks and table render.
  • The clone URL is correct for a fresh machine with no credentials (public repo, HTTPS, no auth prompt).

Docs only.

## What The build-from-source path in #2 had a hole: it told you to install a toolchain and then run commands "from the folder containing this README" — but never said how to *get* that folder, or how to open a terminal in the first place. Someone who has never used a terminal was stuck before Step 1. Adds to Part 2: - **Step 1: open a terminal** — how to launch PowerShell / Terminal on each OS, plus the two things that trip people up (paste keys differ; a password prompt shows no characters). - **Step 3: download the code** — `git clone https://forgejo.owlburtoe.dev/owlburtoe/TRS.git`, what "you are now inside the project folder" means, how to get back there later (`cd ~/TRS`), and `git pull` instead of re-cloning. Collapsed fallback for a browser **Download ZIP** with the drag-the-folder-onto-the-terminal trick for `cd`. - **git** is now installed alongside the other build tools (`winget install --id Git.Git`, `apt/dnf/pacman install git`; macOS gets it from the Xcode CLI tools) and is checked in the verify step. Remaining steps renumbered (install tools → 2, verify → 4, build → 5, collect → 6), and the `Develop` section's link updated to the new anchor. ## Test plan - [ ] Rendered README on Forgejo: anchors resolve, `<details>` blocks and table render. - [ ] The clone URL is correct for a fresh machine with no credentials (public repo, HTTPS, no auth prompt). Docs only. 
The build path assumed the reader already had the repo on disk and knew
how to open a terminal. Add Step 1 (open a terminal) and Step 3 (git
clone, with a browser ZIP fallback), install git alongside the other
build tools, and renumber the remaining steps.
owlburtoe deleted branch docs/install-clone-step 2026-07-14 17:53:08 -04:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
owlburtoe/TRS!3
No description provided.