aboutsummaryrefslogtreecommitdiff
path: root/src/common-utils/README.md
diff options
context:
space:
mode:
authorSamruddhi Khandale <skhandale@microsoft.com>2022-08-05 21:11:46 +0300
committerGitHub <noreply@github.com>2022-08-05 21:11:46 +0300
commit69d3df5f945adc4f7ab5d1198167a1dbc8412fc9 (patch)
tree93b21cd948048778a2b2557783157f40d6ada3d9 /src/common-utils/README.md
parent155bec7262698afd996b9a2ff4659d88bf168abc (diff)
Rename feature: 'common' to 'common-utils' (#79)
* Renaming feature: 'common' to 'common-utils' * removing duplicate tests
Diffstat (limited to 'src/common-utils/README.md')
-rw-r--r--src/common-utils/README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/src/common-utils/README.md b/src/common-utils/README.md
new file mode 100644
index 0000000..d35e688
--- /dev/null
+++ b/src/common-utils/README.md
@@ -0,0 +1,30 @@
+
+# Common Debian utilities (common-utils)
+
+Installs a set of common command line utilities, Oh My Zsh!, and sets up a non-root user.
+
+## Example Usage
+
+```json
+"features": {
+ "devcontainers/features/common-utils@latest": {
+ "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)._