Skip to content

Commit 9a2df94

Browse files
committed
Better docs
1 parent c804c39 commit 9a2df94

4 files changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,33 +25,37 @@ Python project setup using a [Devcontainer](https://containers.dev) and [uv](htt
2525

2626
Alternatively, enter <kbd>Ctrl+Shift+P</kbd> and select **Dev Containers: Reopen in Container**.
2727

28-
Upon opening the Devcontainer, setup will start. Wait for the setup to finish.
28+
3. **Wait for setup to finish**
29+
30+
Upon opening the Devcontainer, setup will start. Wait for the setup to finish before continuing.
2931

3032
![alt text](<docs/Screenshot 2025-04-23 at 18.00.10.png>)
3133

32-
3. **Select Python interpreter**
34+
4. **Select Python interpreter**
3335

3436
Enter <kbd>Ctrl+Shift+P</kbd> and select **Python: Select Interpreter**.
3537

3638
<img src="docs/Screenshot 2025-04-23 at 17.53.28.png" alt="VSCode: Python Select Interpreter" width="500"/>
3739

3840
Select the **venv** (`./.venv/bin/python`).
3941

40-
4. **Enjoy 🫶**
42+
5. **Enjoy 🫶**
4143

4244
You now have a fully configured Python development environment with uv!
4345

4446
![alt text](<docs/Screenshot 2025-04-23 at 17.29.45.png>)
4547

46-
... with pytest:
48+
with tools like `pytest`:
4749

48-
![alt text](<docs/Screenshot 2025-04-23 at 17.58.16.png>)
50+
| UI | Terminal |
51+
|:--:|:--:|
52+
| ![alt text](<docs/Screenshot 2025-04-23 at 18.10.07.png>) | ![alt text](<docs/Screenshot 2025-04-23 at 18.11.34.png>) |
4953

50-
... and tooling like `ruff` and `uv` readily available:
54+
... and `ruff` and `uv` readily available:
5155

5256
<img src="docs/Screenshot 2025-04-23 at 18.03.49.png" width="500"/>
5357

54-
... and CI/CD set up with GitHub Actions:
58+
CI/CD is covered with GitHub Actions. A workflow running testing/linting/formatting is already set up for you.
5559

5660
![alt text](<docs/Screenshot 2025-04-23 at 18.06.47.png>)
5761

-737 KB
Binary file not shown.
78.5 KB
Loading
114 KB
Loading

0 commit comments

Comments
 (0)