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:
parent
8d29a3a42b
commit
36d4fda5aa
6 changed files with 65 additions and 61 deletions
14
README.md
14
README.md
|
|
@ -1,6 +1,6 @@
|
|||
# Computing Setup
|
||||
|
||||
A short, hands-on guide to getting your machine ready for scientific computing work. Inspect your hardware and operating system, install git, and learn enough to clone and pull from public repositories — the essentials before starting any computing course or project.
|
||||
A short, hands-on guide to getting your machine ready for scientific computing work. Inspect your hardware and operating system, install git, and learn enough to clone and pull from public repositories, which are the essentials to learn before getting started on any computing course or project.
|
||||
|
||||
## Sections
|
||||
|
||||
|
|
@ -10,14 +10,14 @@ A short, hands-on guide to getting your machine ready for scientific computing w
|
|||
| [02](02-git-basics/) | **Git basics** | Install git, configure your identity, clone a public repository, and pull updates. Pull-focused — authentication and pushing come later. |
|
||||
| [03](03-editors/) | **Editors** | Install a modern code editor (VS Code recommended), add the essential extensions, and pick an AI coding extension. Configure a few settings that pay back the small investment quickly. |
|
||||
|
||||
This guide is designed for students starting a computing course, but should be useful for anyone setting up a new machine or getting acquainted with one they already own. A follow-on module on git collaboration (authentication, branching, merging, pushing) is planned.
|
||||
This guide is designed for students starting a computing course, but should be useful for anyone setting up a new machine or getting acquainted with one they already own.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- A terminal — Terminal or iTerm on macOS, any terminal emulator on Linux, or PowerShell on Windows
|
||||
- A terminal: Terminal or iTerm on macOS, any terminal emulator on Linux, or PowerShell on Windows
|
||||
- No prior command line or git experience required
|
||||
|
||||
**Windows users — no extra setup to start.** You can work through most of module 01 using PowerShell alone. You will want the Windows Subsystem for Linux (WSL) before tackling module 02 (git) and the optional WSL section at the end of module 01. See [WSL.md](WSL.md) when you get there.
|
||||
**Windows users: no extra setup to start.** You can work through most of module 01 using PowerShell alone. You will want the Windows Subsystem for Linux (WSL) before tackling module 02 (git) and the optional WSL section at the end of module 01. See [WSL.md](WSL.md) when you get there.
|
||||
|
||||
## Getting started
|
||||
|
||||
|
|
@ -34,10 +34,10 @@ Each section has its own `README.md` with a walkthrough and exercises.
|
|||
|
||||
Once you are comfortable with your machine, can pull updates with git, and have a working editor, two companion guides build on this one:
|
||||
|
||||
- [**cli-walkthrough**](https://lem.che.udel.edu/git/furst/cli-walkthrough) — a hands-on tour of the Unix command line: navigation, file manipulation, searching, processes, scripting, and remote access.
|
||||
- [**coding-with-ai**](https://lem.che.udel.edu/git/furst/coding-with-ai) — working effectively with AI coding assistants. The *practice* counterpart to module 03's *setup*: when to copy-paste, when to use the editor, when to use an agent, and how to verify and cite what comes out.
|
||||
- [**cli-walkthrough**](https://lem.che.udel.edu/git/furst/cli-walkthrough). A hands-on tour of the Unix command line, covering navigation, file manipulation, searching, processes, scripting, and remote access.
|
||||
- [**coding-with-ai**](https://lem.che.udel.edu/git/furst/coding-with-ai). Working effectively with AI coding assistants. The *practice* counterpart to module 03's *setup*: when to copy-paste, when to use the editor, when to use an agent, and how to verify and cite what comes out.
|
||||
|
||||
Either order works. Many readers benefit from doing the cli-walkthrough first, since the command line shows up everywhere afterward.
|
||||
Either order works. Many readers will benefit from doing the cli-walkthrough first, since the command line shows up everywhere afterward.
|
||||
|
||||
## License
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue