Uzurka/ansible-role-oh-my-zsh
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated README

Browse Source
This commit is contained in:
uzurka
2025-01-09 20:06:21 +01:00
parent 9fafbcc7c2
commit 231e9299a3
1 changed files with 3 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -16,17 +16,14 @@ This is a basic Ansible role to enable and configure Oh My Zsh on Fedora, Ubuntu
| **Variable name** | **Default value** | **Description** |
|----------------|---------------|-------------|
| `zsh_users` | `{{ ansible_user_id }}` | List of users to install Zsh, Oh My ZSH and PowerLevel10K |
| `omz_install_zsh` | `false` | Defines whether or not the role should attempt to install Zsh. |
| `omz_user` | `[]` | The user to install/configure (Oh My) Zsh for. See below for its properties. |
| `omz_user.name` | `-` | The name of the user. |
| `omz_user.group` | `-` | The group of the user |
| `omz_user.settings` | `-` | Extra settings (as a mult-line string) such as variable exports or aliases to add to the user's `.zshrc` file. Only used if `omz_zshrc_create` is `true`. |
| `omz_custom_settings` | `-` | Extra settings (as a mult-line string) such as variable exports or aliases to add to the user's `.zshrc` file. Only used if `omz_zshrc_create` is `true`. |
| `omz_git_repository` | `https://github.com/robbyrussell/oh-my-zsh.git` | The git repo to clone Oh My Zsh from. |
| `omz_install_directory` | `.oh-my-zsh` | The name of the directory to clone Oh My Zsh into. |
| `omz_zshrc_create` | `true` | Whether or not to create `.zshrc`. If `true`, will create `.zshrc` from a template. |
| `omz_zshrc_template` | `templates/zshrc.zsh-template.j2` | The template used to create the user's `.zshrc` file when `omz_zshrc_create` is `true`. |
| `omz_zshrc_backup` | `true` | Whether or not to create backup the existing `.zshrc` files when the role changes it. |
| `omz_zsh_theme` | `robbyrussell` | See `templates/zshrc.zsh-template`. |
| `omz_case_sensitive` | `false` | See `templates/zshrc.zsh-template`. |
| `omz_hyphen_insensitive` | `false` | See `templates/zshrc.zsh-template`. |
| `omz_disable_auto_update` | `false` | See `templates/zshrc.zsh-template`. |
@ -40,12 +37,10 @@ This is a basic Ansible role to enable and configure Oh My Zsh on Fedora, Ubuntu
| `omz_zsh_custom` | `$ZSH/custom` | See `templates/zshrc.zsh-template`. |
| `omz_plugins` | `[]` | A list of Oh My Zsh plugins to enable. |
## Role variables - ZSH - Oh My ZSH
## Role variables - Oh My ZSH
| **Variable name** | **Default value** | **Description** |
|-----------------------------------|---------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|
| `p10k_repository_url` | `'https://github.com/romkatv/powerlevel10k.git'` | GitHub repository URL for Powerlevel10k. |
| `p10k_users` | `["{{ ansible_user_id }}"]` | List of Linux users to install Powerlevel10k for. If empty, the current user will be used. |
| `zsh_plugin` | `zsh` | Zsh plugin to use, such as zsh, ohmyzsh, prezto, Zim, etc. Full plugin list [here](https://github.com/romkatv/powerlevel10k#installation). |
| `p10k_prompt_style` | `"classic"` | Powerlevel10k theme style to use. |
| `p10k_prompt_time` | `"24-hour"` | Time format to display in the prompt. Valid values: no, 24-hour, 12-hour. |
| `p10k_prompt_separator` | `"angled"` | Prompt separator. Valid values: angled, vertical, slanted, round. |