Restyle top README and add next-steps pointer
- Convert the modules list into a Sections table with topic and description columns, matching the structure of the cli-walkthrough README for consistency across the two repos. - Add a Next steps section pointing readers to cli-walkthrough as the natural sequel once they are comfortable with their machine and can pull updates with git. - Trim the "How to use this guide" section into a shorter Getting started block, again matching cli-walkthrough. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
parent
0c6e919bdd
commit
c566aabe16
1 changed files with 17 additions and 11 deletions
28
README.md
28
README.md
|
|
@ -1,33 +1,39 @@
|
||||||
# Computing Setup
|
# Computing Setup
|
||||||
|
|
||||||
A short, hands-on guide to getting your machine ready for scientific computing work. There are two modules:
|
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.
|
||||||
|
|
||||||
1. [**Know your machine**](01-know-your-machine/) — identify your OS, CPU, RAM, storage, and GPU, and learn what each does.
|
## Sections
|
||||||
2. [**Git basics**](02-git-basics/) — install git, configure it, and use it to download and update course (or any public) materials.
|
|
||||||
|
|
||||||
This repo 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.
|
| # | Topic | Description |
|
||||||
|
|---|-------|-------------|
|
||||||
|
| [01](01-know-your-machine/) | **Know your machine** | Identify your OS, CPU, RAM, storage, and GPU. Learn the commands to query each on macOS, Linux, and Windows, and understand how the WSL virtual machine differs from the physical hardware. |
|
||||||
|
| [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. |
|
||||||
|
|
||||||
A follow-on module on git collaboration (authentication, branching, merging, pushing) is planned. For now, this guide is pull-only.
|
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.
|
||||||
|
|
||||||
## Prerequisites
|
## 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
|
- 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, however, 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.
|
||||||
|
|
||||||
## How to use this guide
|
## Getting started
|
||||||
|
|
||||||
You can read each module right here on the web — no setup needed to start. Each module is self-contained and tells you exactly which commands to run on your own machine.
|
You can read each module right here on the web — no setup is needed to begin. Once you have completed module 02 (git), you can optionally clone the repository for offline access:
|
||||||
|
|
||||||
Once you have completed module 02 (git), you can optionally clone this repository for offline access:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://lem.che.udel.edu/git/furst/computing-setup.git
|
git clone https://lem.che.udel.edu/git/furst/computing-setup.git
|
||||||
cd computing-setup
|
cd computing-setup
|
||||||
```
|
```
|
||||||
|
|
||||||
Each module has its own `README.md` with a walkthrough and exercises.
|
Each section has its own `README.md` with a walkthrough and exercises.
|
||||||
|
|
||||||
|
## Next steps
|
||||||
|
|
||||||
|
Once you are comfortable with your machine and can pull updates with git, learn to *use* the command line:
|
||||||
|
|
||||||
|
- [**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. The natural sequel to this guide.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue