Skip to content

Commit 36efb55

Browse files
committed
fix: suffix .devcontainer files with .sample and add README sec
1 parent c3f0498 commit 36efb55

File tree

4 files changed

+18
-0
lines changed

4 files changed

+18
-0
lines changed
File renamed without changes.
File renamed without changes.

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ cmake-build-release/
2727
.vscode
2828
.cache
2929

30+
# devcontainer
31+
.devcontainer/*
32+
!.devcontainer/*.sample
33+
3034
# meson subprojects - wrap files need to be kept to let meson download
3135
# dependencies as needed, but dependencies themselves should not be versioned
3236
/subprojects/*

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,20 @@ pre-commit install
100100

101101
This will setup a git pre-commit-hook that is executed on each commit and will report the linting problems. To run all hooks on all files use `pre-commit run -a`.
102102

103+
### Dev Containers
104+
105+
We provide sample Dev Container configuration files.
106+
107+
To use a Dev Container as your development environment, follow the steps below, then select `Dev Containers: Reopen in Container` from VS Code's Command Palette.
108+
109+
```
110+
cd .devcontainer
111+
cp Dockerfile.sample Dockerfile
112+
cp devcontainer.json.sample devcontainer.json
113+
```
114+
115+
If you make improvements that could benefit all developers, please update the sample files and submit a pull request.
116+
103117
## License
104118

105119
Licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)

0 commit comments

Comments
 (0)