Skip to content

Commit 94503e8

Browse files
sourylimeclaude
andcommitted
README: make the SSH key step friendlier for first-time terminal users
Spell out how to open the terminal on each OS, what ssh-keygen's prompts mean (just press Return to accept defaults), where the .pub file actually lands, and how to get its contents into GitHub — instead of assuming familiarity with shorthand like 'key at ~/.ssh/id_ed25519.pub'. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
1 parent e95e9d0 commit 94503e8

1 file changed

Lines changed: 25 additions & 6 deletions

File tree

README.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -83,12 +83,31 @@ Grab the latest build for your system from the
8383

8484
The comma only allows computers whose SSH key is registered to it via a GitHub account.
8585

86-
1. **Make an SSH key** (skip if you already have `~/.ssh/id_ed25519`):
87-
- **macOS / Linux:** `ssh-keygen -t ed25519` → key at `~/.ssh/id_ed25519.pub`
88-
- **Windows:** `ssh-keygen -t ed25519` in **PowerShell** (built into Windows 10/11) → key at
89-
`%USERPROFILE%\.ssh\id_ed25519.pub`
90-
2. **Add the `.pub` key to a GitHub account** at
91-
[github.com/settings/keys](https://github.com/settings/keys)*New SSH key*.
86+
1. **Make an SSH key.** This is a pair of files your computer uses to prove it's you —
87+
you only need to do this once per computer (skip it if you already have a file at
88+
`~/.ssh/id_ed25519`).
89+
- **macOS:** open **Terminal** (⌘+Space, type "Terminal", press Return).
90+
- **Linux:** open your terminal app.
91+
- **Windows:** open **PowerShell** (press the Windows key, type "PowerShell", press
92+
Enter) — it's built into Windows 10/11, nothing to install.
93+
94+
Then, in that terminal window, type this and press Return:
95+
```
96+
ssh-keygen -t ed25519
97+
```
98+
It'll ask **"Enter file in which to save the key"** and **"Enter passphrase"**
99+
just press Return at each prompt to accept the defaults (no passphrase). That
100+
creates two files: a private key (never share this one) and a matching `.pub`
101+
("public") file, which is the one you'll copy in the next step:
102+
- **macOS / Linux:** `~/.ssh/id_ed25519.pub`
103+
- **Windows:** `%USERPROFILE%\.ssh\id_ed25519.pub` (typically
104+
`C:\Users\<your username>\.ssh\id_ed25519.pub`)
105+
2. **Add the `.pub` key to a GitHub account.** Open the `.pub` file in any text editor
106+
(Notepad, TextEdit, etc.) and copy its entire contents — it's one long line starting
107+
with `ssh-ed25519`. Go to
108+
[github.com/settings/keys](https://github.com/settings/keys)**New SSH key**,
109+
paste it in, and save. (Don't have a GitHub account? Making one is free at
110+
[github.com](https://github.com).)
92111
3. **On the comma:** Settings → Developer → enable **SSH**, and enter **that GitHub username**.
93112
(On sunnypilot it's under the Developer section.)
94113

0 commit comments

Comments
 (0)