Skip to content

Commit 832412f

Browse files
committed
fix: doc: devcontainer instructions
Signed-off-by: thediveo <[email protected]>
1 parent dce4c8d commit 832412f

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,16 @@ Application programmers then simply deal with enumeration values in form of
2727
uints (or ints, _erm_, anything that satisfies `constraints.Integer`s),
2828
liberated from parsing strings and validating enumeration flags.
2929

30+
For devcontainer instructions, please see the [section "DevContainer"
31+
below](#devcontainer).
32+
3033
## Alternatives
3134

3235
In case you are just interested in string-based one-of-a-set flags, then the
3336
following packages offer you a minimalist approach:
3437

3538
- [hashicorp/packer/helper/enumflag](https://godoc.org/github.com/hashicorp/packer/helper/enumflag)
3639
really is a reduced-to-the-max version without any whistles and bells.
37-
3840
- [creachadair/goflags/enumflag](https://godoc.org/github.com/creachadair/goflags/enumflag)
3941
has a similar, but slightly more elaborate API with additional "indices" for
4042
enumeration values.
@@ -346,16 +348,13 @@ func Example_slice() {
346348

347349
## DevContainer
348350

349-
First method:
350-
351-
1. in VSCode: Ctrl+Shift+P, "Dev Containers: Open Workspace in Container..."
352-
2. select `enumflag.code-workspace` and off you go...
353-
354-
Second method:
351+
> [!CAUTION] Do **not** use VSCode's "~~Dev Containers: Clone Repository in
352+
> Container Volume~~" command, as it is utterly broken by design, ignoring
353+
> `.devcontainer/devcontainer.json`.
355354
356-
1. In VSCode: Ctrl+Shift+P, "Dev Containers: Clone Repository in Container Volume..."
357-
2. select "Github"
358-
3. enter "thediveo/enumflag" and off you go...
355+
1. `git clone https://github.com/thediveo/enumflag`
356+
2. in VSCode: Ctrl+Shift+P, "Dev Containers: Open Workspace in Container..."
357+
3. select `enumflag.code-workspace` and off you go...
359358

360359
## VSCode Tasks
361360

0 commit comments

Comments
 (0)