From fa6f1354cdfba103526835b314d5987da219eb56 Mon Sep 17 00:00:00 2001 From: Gabriel Arazas Date: Sat, 15 Mar 2025 16:26:52 +0800 Subject: [PATCH] docs: init README for devcontainers --- devcontainers/README.adoc | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 devcontainers/README.adoc diff --git a/devcontainers/README.adoc b/devcontainers/README.adoc new file mode 100644 index 00000000..fdeb275f --- /dev/null +++ b/devcontainers/README.adoc @@ -0,0 +1,19 @@ += devcontainers +:toc: + + +Docker/OCI containers that are entirely built with Nix ecosystem. +For now, it is required to have `flakes` experimental feature enabled since some of the containers make use of them. footnote:[Ideally, it shouldn't but importing other Nix projects is pretty painful unless we go with either flakes and a dedicated pinning tool all the way.] + +You can build this set of containers with the following command: + +[source, shell] +---- +# Either by referring to the files (which is easier IMO)... +nix build -f ./devcontainers [NAME] # or no name at all to build all of them. + +# ...or by referring to the flake output. +nix build .#devContainers.$SYSTEM.$NAME +---- + +This set of containers should also be published at GitHub Container Registry at `ghcr.io/foo-dogsquared/nixos-config/$NAME`