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 2026-05-29 09:53:40 -04:00
commit 36d4fda5aa
6 changed files with 65 additions and 61 deletions

View file

@ -9,7 +9,7 @@ A good editor is the cockpit you work from every day. It is worth a little setup
- Install a modern code editor (VS Code recommended) and the essential extensions
- Add an AI coding extension and understand the basic options
- Configure a few editor settings that pay back the small investment quickly
- Know where to learn the *workflow* of using these tools — this module is setup, not practice
- Know where to learn the *workflow* of using these tools. This module is setup, not practice.
---
@ -21,8 +21,8 @@ A quick taxonomy:
- **Code editors** (VS Code, Sublime Text, Neovim with plugins) understand programming languages: syntax highlighting, autocompletion, integrated terminal, version-control awareness, extensions for almost everything.
- **IDEs** (PyCharm, IntelliJ IDEA, Visual Studio, Xcode) are heavier code editors tailored to a specific language or platform, with deeper refactoring tools and built-in build systems. Powerful but with more to learn.
- **Terminal-based** (steep learning curves, devoted user bases):
Neovim — a modern Vim fork. The AI plugins like copilot.vim, avante.nvim, codecompanion.nvim are mature.
Emacs — also venerable, cross-platform, with AI packages like copilot.el and gptel.
**Neovim.** A modern Vim fork. The AI plugins like copilot.vim, avante.nvim, codecompanion.nvim are mature.
**Emacs.** Also venerable, cross-platform, with AI packages like copilot.el and gptel.
For a general-purpose scientific computing setup, a code editor is the sweet spot. VS Code is the most widely used today and is what this module installs.
@ -33,10 +33,10 @@ For a general-purpose scientific computing setup, a code editor is the sweet spo
A few alternatives worth knowing exist but aren't installed here:
- **Cursor** and **Windsurf** — forks of VS Code with deeper AI integration baked in (instead of bolted on as extensions). Same shortcuts, same UI, similar extension support. If you find yourself doing heavy agentic work, worth a look.
- **PyCharm** (Community Edition is free) — heavier IDE, strong refactoring tools, popular among Python-focused teams.
- **Neovim** with AI plugins — for the terminal-first crowd. Steep learning curve, satisfying for those who learn it.
- **Zed** — a newer, performance-focused editor with growing AI features.
- **Cursor** and **Windsurf**. Forks of VS Code with deeper AI integration baked in (instead of bolted on as extensions). Same shortcuts, same UI, similar extension support. If you find yourself doing heavy agentic work, worth a look.
- **PyCharm** (Community Edition is free). Heavier IDE, strong refactoring tools, popular among Python-focused teams.
- **Neovim** with AI plugins. For the terminal-first crowd. Steep learning curve, satisfying for those who learn it.
- **Zed**. A newer, performance-focused editor with growing AI features.
Switching editors later is not a major event. Start with VS Code; revisit if you have a specific reason.
@ -78,10 +78,10 @@ After installing on any OS, open a terminal and run:
code --version
```
You should see version numbers. If the command is not found, VS Code is not on your PATH — fix it as follows:
You should see version numbers. If the command is not found, VS Code is not on your PATH. Fix it as follows:
- **macOS:** open VS Code and run *Shell Command: Install 'code' command in PATH* from the command palette (`Cmd+Shift+P`).
- **Linux:** package-manager installs put `code` on the PATH automatically. A manually downloaded `.deb` or tarball may not — re-run the package installer or follow the instructions on the download page.
- **Linux:** package-manager installs put `code` on the PATH automatically. A manually downloaded `.deb` or tarball may not. Re-run the package installer or follow the instructions on the download page.
- **Windows:** re-run the Windows installer and tick the "Add to PATH" option, or add the install directory manually. On Windows with WSL, the `code` command works from both PowerShell *and* your WSL shell (the WSL extension installs a shim inside WSL).
@ -142,10 +142,10 @@ After installation, you should see inline suggestions begin to appear as you typ
Open Settings with `Cmd+,` (macOS) or `Ctrl+,` (elsewhere). A few that pay back the small investment:
- **Settings Sync** (the gear icon in the bottom-left → *Backup and Sync Settings*) — syncs your settings, extensions, and keybindings across machines using a GitHub or Microsoft account. Set up once; saves an afternoon every time you set up a new machine.
- **Settings Sync** (the gear icon in the bottom-left → *Backup and Sync Settings*). Syncs your settings, extensions, and keybindings across machines using a GitHub or Microsoft account. Set up once; saves an afternoon every time you set up a new machine.
- **Integrated Terminal** (`` Ctrl+` `` / `` Cmd+` ``) — VS Code has a terminal built in. On Windows, you can set the default profile to WSL (open the terminal, click the dropdown next to the `+`, choose **Select Default Profile**, pick **Ubuntu** or your WSL distro).
- **Format on Save** Settings → search for *Format On Save* → enable. Combined with a formatter extension (e.g., **Black** for Python, **Prettier** for JS/TS), this auto-formats every save.
- **Auto Save** Settings → search for *Files: Auto Save* → set to `afterDelay` if you want VS Code to save automatically. Some people love it, some hate it; try it for a week.
- **Format on Save.** Settings → search for *Format On Save* → enable. Combined with a formatter extension (e.g., **Black** for Python, **Prettier** for JS/TS), this auto-formats every save.
- **Auto Save.** Settings → search for *Files: Auto Save* → set to `afterDelay` if you want VS Code to save automatically. Some people love it, some hate it; try it for a week.
- **Themes**`Cmd+Shift+P`*Color Theme*. Cosmetic, but you stare at this thing for hours. Pick one you can read comfortably.
@ -164,9 +164,9 @@ Then create a small Python file, start typing a function signature, and see whet
## Where to go next
This module covered *setup*. Knowing **when** to copy-paste, **when** to use the editor, and **when** to use agents — and how to use each well — is the subject of a companion guide:
This module covered *setup*. Knowing **when** to copy-paste, **when** to use the editor, and **when** to use agents (and how to use each well) is the subject of a companion guide:
- [**coding-with-ai**](https://lem.che.udel.edu/git/furst/coding-with-ai) Working effectively with AI coding assistants. The natural next step once your editor is configured.
- [**coding-with-ai**](https://lem.che.udel.edu/git/furst/coding-with-ai). Working effectively with AI coding assistants. The natural next step once your editor is configured.
## Exercises