Skip to content

Commit b04ee83

Browse files
committed
Improve docs consistency and add repo verification scripts
1 parent d8a5dfd commit b04ee83

18 files changed

Lines changed: 145 additions & 6 deletions

File tree

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ On Windows (MSYS2/MinGW), run `types_and_io_example.exe`.
104104
### Windows + WSL example
105105

106106
```bash
107-
cd /mnt/d/REPOS/personal/learn-programming-languages-with-examples
107+
cd /path/to/learn-programming-languages-with-examples
108108
g++ -std=c++17 -Wall -Wextra -pedantic languages/cpp/01-foundations/types-and-io/example/main.cpp -o types_and_io_example
109109
./types_and_io_example
110110
```
@@ -131,6 +131,16 @@ Run one module example quickly:
131131
bash ./scripts/run-module.sh languages/cpp/01-foundations/strings
132132
```
133133

134+
Run full repository checks (links + C++ build):
135+
136+
```powershell
137+
./scripts/verify-repo.ps1
138+
```
139+
140+
```bash
141+
bash ./scripts/verify-repo.sh
142+
```
143+
134144
### Common First Errors
135145

136146
- `g++: command not found`: install `g++` (MSYS2/MinGW on Windows or `g++` in WSL/Linux)

languages/cpp/01-foundations/formatted-output-and-iomanip/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ g++ -std=c++17 -Wall -Wextra -pedantic example/main.cpp -o iomanip_example
99
./iomanip_example
1010
```
1111

12+
## More Examples
13+
14+
- `example/main.cpp` is the primary runnable sample for this module.
15+
- Try one variation: copy it to `example/variation.cpp`, change one rule, and compare outputs.
16+
1217
## Topics Covered
1318

1419
- `std::fixed` and `std::setprecision`.

languages/cpp/01-foundations/operators-and-expressions/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ g++ -std=c++17 -Wall -Wextra -pedantic example/main.cpp -o operators_example
99
./operators_example
1010
```
1111

12+
## More Examples
13+
14+
- `example/main.cpp` is the primary runnable sample for this module.
15+
- Try one variation: copy it to `example/variation.cpp`, change one rule, and compare outputs.
16+
1217
## Topics Covered
1318

1419
- Arithmetic operators (`+`, `-`, `*`, `/`, `%`).

languages/cpp/01-foundations/scope-and-lifetime-basics/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ g++ -std=c++17 -Wall -Wextra -pedantic example/main.cpp -o scope_lifetime_exampl
99
./scope_lifetime_example
1010
```
1111

12+
## More Examples
13+
14+
- `example/main.cpp` is the primary runnable sample for this module.
15+
- Try one variation: copy it to `example/variation.cpp`, change one rule, and compare outputs.
16+
1217
## Topics Covered
1318

1419
- Block scope (`{ ... }`).

languages/cpp/02-core/algorithms-basics/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ g++ -std=c++17 -Wall -Wextra -pedantic example/main.cpp -o algorithms_basics_exa
99
./algorithms_basics_example
1010
```
1111

12+
## More Examples
13+
14+
- `example/main.cpp` is the primary runnable sample for this module.
15+
- Try one variation: copy it to `example/variation.cpp`, change one rule, and compare outputs.
16+
1217
## Topics Covered
1318

1419
- Linear search.

languages/cpp/02-core/error-handling-and-defensive-programming/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ g++ -std=c++17 -Wall -Wextra -pedantic example/main.cpp -o defensive_programming
99
./defensive_programming_example
1010
```
1111

12+
## More Examples
13+
14+
- `example/main.cpp` is the primary runnable sample for this module.
15+
- Try one variation: copy it to `example/variation.cpp`, change one rule, and compare outputs.
16+
1217
## Topics Covered
1318

1419
- Defensive input validation.

languages/cpp/02-core/input-validation/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ g++ -std=c++17 -Wall -Wextra -pedantic example/main.cpp -o input_validation_exam
99
./input_validation_example
1010
```
1111

12+
## More Examples
13+
14+
- `example/main.cpp` is the primary runnable sample for this module.
15+
- Try one variation: copy it to `example/variation.cpp`, change one rule, and compare outputs.
16+
1217
## Topics Covered
1318

1419
- Detecting extraction failure (`if (!(cin >> value))`).

languages/cpp/03-advanced/constructors-and-invariants/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ g++ -std=c++17 -Wall -Wextra -pedantic example/main.cpp -o constructors_invarian
99
./constructors_invariants_example
1010
```
1111

12+
## More Examples
13+
14+
- `example/main.cpp` is the primary runnable sample for this module.
15+
- Try one variation: copy it to `example/variation.cpp`, change one rule, and compare outputs.
16+
1217
## Topics Covered
1318

1419
- Constructor initialization.

languages/cpp/03-advanced/copy-and-move-semantics/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ g++ -std=c++17 -Wall -Wextra -pedantic example/main.cpp -o copy_move_example
99
./copy_move_example
1010
```
1111

12+
## More Examples
13+
14+
- `example/main.cpp` is the primary runnable sample for this module.
15+
- Try one variation: copy it to `example/variation.cpp`, change one rule, and compare outputs.
16+
1217
## Topics Covered
1318

1419
- Copy constructor and copy assignment.

languages/cpp/04-expert/concurrency-basics/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@ g++ -std=c++17 -Wall -Wextra -pedantic -pthread example/main.cpp -o concurrency_
1111

1212
On Linux, `-pthread` is required for thread support.
1313

14+
## More Examples
15+
16+
- `example/main.cpp` is the primary runnable sample for this module.
17+
- Try one variation: copy it to `example/variation.cpp`, change one rule, and compare outputs.
18+
1419
## Topics Covered
1520

1621
- Creating and joining threads with `std::thread`.

0 commit comments

Comments
 (0)