Skip to content

Commit fc040fb

Browse files
committed
Improve root README onboarding
1 parent 4440616 commit fc040fb

1 file changed

Lines changed: 27 additions & 2 deletions

File tree

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,46 @@ This repository teaches programming through small runnable examples and focused
66

77
- Five active language tracks: C++, C#, Go, Python, and TypeScript.
88
- Shared concept naming across tracks for easier comparison.
9+
- Each module follows the same shape: `README.md`, `example/main.*`, and two exercises.
10+
- Each implemented level ends with a project and an assessment checkpoint.
911
- VS Code-first workflow, with scripts for Windows PowerShell and Bash.
1012

13+
## Repo Prerequisites
14+
15+
For the full local pipeline, install:
16+
17+
- Python 3
18+
- a C++17-capable `g++`
19+
- Go
20+
- .NET 8 SDK
21+
- Node LTS with `npm`
22+
23+
If you only want to learn one track, follow that track README first because language-specific prerequisites differ.
24+
1125
## Start Here
1226

27+
### Learning Path
28+
1329
1. Choose your language guide:
1430
- [C++ Guide](languages/cpp/README.md)
1531
- [C# Guide](languages/csharp/README.md)
1632
- [Go Guide](languages/go/README.md)
1733
- [Python Guide](languages/python/README.md)
1834
- [TypeScript Guide](languages/typescript/README.md)
19-
2. Open the `01-foundations` roadmap for your selected language.
35+
2. Start at the first roadmap for that track:
36+
- C++: [00-setup](languages/cpp/00-setup/README.md), then `01-foundations`
37+
- C#, Go, Python, TypeScript: `01-foundations`
2038
3. Run one module example.
2139
4. Solve `exercises/01` and `exercises/02` in that module.
2240
5. Mark progress in the language checklist.
2341

42+
### Contributor Path
43+
44+
1. Read [CONTRIBUTING.md](CONTRIBUTING.md).
45+
2. Install the repo prerequisites listed above.
46+
3. Run `./scripts/verify-repo.ps1` or `bash ./scripts/verify-repo.sh`.
47+
4. Run `./scripts/lint.ps1` or `bash ./scripts/lint.sh` before opening a pull request.
48+
2449
## Language Status
2550

2651
| Language | Current Levels | Coverage | Track Status |
@@ -105,7 +130,7 @@ A standardized `## Learning Metadata` block is required before `## Quick Run` fo
105130
Checkpoint artifacts under `languages/<language>/projects/*` and `languages/<language>/assessments/*` should mirror the corresponding C++ checkpoint style:
106131

107132
- `README.md`
108-
- runnable entrypoint (`main.cs` + `.csproj`, `main.go`, `main.py`, or `main.ts`)
133+
- runnable entrypoint (`main.cpp` in C++, `main.cs` + `.csproj` in C#, `main.go` in Go, `main.py` in Python, or `main.ts` in TypeScript)
109134
- same learner goal, input/output shape, and acceptance expectations as the C++ version
110135

111136
## Example Commenting Standard

0 commit comments

Comments
 (0)