Skip to content

Commit 122e341

Browse files
author
Alan Christie
committed
docs: README tweak
1 parent 108c61c commit 122e341

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Squonk2 VS Code Python Dev Container
1+
# Squonk2 VS Code Python DevContainer
22

33
![build](https://github.com/informaticsmatters/squonk2-python-vscode-dev-container/actions/workflows/build.yaml/badge.svg?branch=3.13)
44

@@ -10,16 +10,21 @@ your project or workspace `.devcontainer` directory and VS Code should do the re
1010
2. `Dockerfile`
1111
3. `requirements.txt`
1212

13-
The above creates an image with the following main components (amongst others): -
13+
The above creates an image with the user "vscode" and the following tools
14+
installed (amongst others): -
1415

15-
- Python (3.13 "slim")
16-
- Poetry (1.8)
17-
- Pre-Commit (4.2)
18-
- Ansible (11.8)
16+
- python (3.13 "slim")
17+
- poetry (1.8)
18+
- pre-Commit (4.2)
19+
- ansible (11.8)
1920
- kubectl (1.31)
20-
- Popeye (0.22)
21+
- popeye (0.22)
2122
- Docker-in-Docker
2223

24+
**NOTE** You need a directory `~/k8s-config` on your local machine. The
25+
Dev-Container expects this. This is where we put all our kubernetes cluster
26+
config files and it wil lbe mounted into the DevContainer as `/k8s-config`.
27+
2328
> Separate branches of this repository will be maintained
2429
for each active Major/Minor Python version used in our Projects.
2530
So you'll find a 3.13 branch for our Python 3.13 projects.

0 commit comments

Comments
 (0)