aboutsummaryrefslogtreecommitdiff
path: root/src/common/README.md
diff options
context:
space:
mode:
authorJosh Spicer <joshspicer@github.com>2022-06-14 03:01:19 +0300
committerGitHub <noreply@github.com>2022-06-14 03:01:19 +0300
commit2fa323248528604a3548fd1292c74c7b473c611b (patch)
tree39831944b1ed879a3342310b6f2a107e48153aad /src/common/README.md
parentfac5e5a4540ffc79138b94ce8edfd329a209b250 (diff)
Devcontainer docs (#47)
* docs * automatically generate documentation from features.json * trigger doc gen * 1 * no-ci * no-ci * no-ci * no-ci * comment out pull * Automated documentation update * no-ci markdown table * Automated documentation update * no-ci * Automated documentation update * branch to main Co-authored-by: Devcontainers CI <vscr-feedback@microsoft.com>
Diffstat (limited to 'src/common/README.md')
-rw-r--r--src/common/README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/src/common/README.md b/src/common/README.md
new file mode 100644
index 0000000..ba27a5f
--- /dev/null
+++ b/src/common/README.md
@@ -0,0 +1,33 @@
+
+# common (common)
+
+common
+
+## Example Usage
+
+```json
+"features": [
+ {
+ "id": "devcontainers/features/common@latest",
+ "options": {
+ "version": "latest"
+ }
+ }
+]
+```
+
+## Options
+
+| Options Id | Description | Type | Default Value |
+|-----|-----|-----|-----|
+| install_Zsh | Install ZSH? | boolean | true |
+| install_Oh_My_Zsh | Install Oh My Zsh!? | boolean | true |
+| upgrade_packages | Upgrade OS packages? | boolean | true |
+| username | Enter name of non-root user to configure or none to skip | string | automatic |
+| user_uid | Enter uid for non-root user | string | automatic |
+| user_gid | Enter gid for non-root user | string | automatic |
+| add_non_free_packages | Add packages from non-free Debian repository? | boolean | - |
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](./devcontainer-feature.json)._