Skip to content

Commit 7ba5fa1

Browse files
committed
remove reference to Dockerfile and VARIANT argument. Refer to image argument in devcontainer.json. Reference devcontainer org images.
1 parent 1cdefb0 commit 7ba5fa1

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,10 @@ It includes `pytest` for testing plus the `pytest-cov` plugin to measure coverag
1111

1212
The checks and tests are all run using Github actions on every pull request and merge to main.
1313

14-
This repository is setup for Python 3.11. To customize that, change the `VARIANT` argument in `.devcontainer/devcontainer.json`, change the config options in `.precommit-config.yaml` and change the version number in `.github/workflows/python.yaml`.
14+
This repository is setup for Python 3.11. To customize that:
15+
1. Change the `image` argument in `.devcontainer/devcontainer.json` (see [https://github.com/devcontainers/images/tree/main/src/python](https://github.com/devcontainers/images/tree/main/src/python#configuration) for a list of pre-built Docker images)
16+
1. change the config options in `.precommit-config.yaml`
17+
1. change the version number in `.github/workflows/python.yaml`
1518

1619
## Development instructions
1720

@@ -55,7 +58,6 @@ Here's a short explanation of each file/folder in this template:
5558

5659
* `.devcontainer`: Folder containing files used for setting up a devcontainer
5760
* `devcontainer.json`: File configuring the devcontainer, includes VS Code settings
58-
* `Dockerfile`: File with commands to build the devcontainer's Docker image
5961
* `.github`: Folder for Github-specific files and folders
6062
* `workflows`: Folder containing Github actions config files
6163
* `python.yaml`: File configuring Github action that runs tools and tests

0 commit comments

Comments
 (0)