summaryrefslogtreecommitdiff
path: root/features/src/common-utils/NOTES.md
diff options
context:
space:
mode:
authorNeonXP <i@neonxp.ru>2024-01-28 20:43:11 +0300
committerNeonXP <i@neonxp.ru>2024-01-28 22:07:35 +0300
commit11412b2e720f754900b39d195f33af39ed11d085 (patch)
tree96d7e561f21809aead3c0f25034f083f46ef064c /features/src/common-utils/NOTES.md
parent6c00916212073678bbeb3bdde3f121c4efad707a (diff)
Go теперь фича над базовым образомHEADmaster
Diffstat (limited to 'features/src/common-utils/NOTES.md')
-rw-r--r--features/src/common-utils/NOTES.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/features/src/common-utils/NOTES.md b/features/src/common-utils/NOTES.md
new file mode 100644
index 0000000..f2c7aa7
--- /dev/null
+++ b/features/src/common-utils/NOTES.md
@@ -0,0 +1,26 @@
+## OS Support
+
+This Feature should work on recent versions of Debian/Ubuntu, RedHat Enterprise Linux, Fedora, RockyLinux, and Alpine Linux.
+
+## Using with dev container images
+
+This Feature is used in many of the [dev container images](https://github.com/search?q=repo%3Adevcontainers%2Fimages+%22ghcr.io%2Fdevcontainers%2Ffeatures%2Fcommon-utils%22&type=code), as a result
+these images have already allocated UID & GID 1000. Attempting to add this Feature with UID 1000 and/or GID 1000 on top of such a dev container image will result in an error when building the dev container.
+
+## Customizing the command prompt
+
+By default, this script provides a custom command prompt that includes information about the git repository for the current folder. However, with certain large repositories, this can result in a slow command prompt due to the performance of needed git operations.
+
+For performance reasons, a "dirty" indicator that tells you whether or not there are uncommitted changes is disabled by default. You can opt to turn this on for smaller repositories by entering the following in a terminal or adding it to your `postCreateCommand`:
+
+```bash
+git config devcontainers-theme.show-dirty 1
+```
+
+To completely disable the git portion of the prompt for the current folder's repository, you can use this configuration setting instead:
+
+```bash
+git config devcontainers-theme.hide-status 1
+```
+
+For `zsh`, the default theme is a [standard Oh My Zsh! theme](https://ohmyz.sh/). You may pick a different one by modifying the `ZSH_THEME` variable in `~/.zshrc`.