From e46e633902e5834b4bda8422aa315baa61b11ab6 Mon Sep 17 00:00:00 2001 From: uzurka Date: Thu, 9 Jan 2025 17:17:41 +0100 Subject: [PATCH] updated readme --- README.md | 86 ++++++++++++------------------------------------------- 1 file changed, 18 insertions(+), 68 deletions(-) diff --git a/README.md b/README.md index f7954c2..f8f0819 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ This is a basic Ansible role to enable and configure Oh My Zsh on Fedora, Ubuntu ## Role variables - ZSH - Oh My ZSH -| Variable name | Default value | Description | +| **Variable name** | **Default value** | **Description** | |----------------|---------------|-------------| | `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. | @@ -41,74 +41,24 @@ This is a basic Ansible role to enable and configure Oh My Zsh on Fedora, Ubuntu | `omz_plugins` | `[]` | A list of Oh My Zsh plugins to enable. | ## Role variables - ZSH - Oh My ZSH -Available variables are listed below, along with default values (see `defaults/main.yml`): +| **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. | +| `p10k_prompt_head` | `"sharp"` | Prompt head. Valid values: sharp, blurred, slanted, round. | +| `p10k_prompt_tails` | `"flat"` | Prompt tail. Valid values: flat, blurred, sharp, slanted, round. | +| `p10k_prompt_height` | `"two-lines"` | Terminal prompt height. Valid values: one-line, two-lines. | +| `p10k_prompt_connection` | `"disconnected"` | Prompt connection (only used if `p10k_prompt_height` is set to `two-lines`). | +| `p10k_prompt_connection_color` | `"dark"` | Connection color for the prompt (only used if `p10k_prompt_connection` is `dotted` or `solid`). | +| `p10k_prompt_frame` | `"left"` | Prompt frame. Valid values: no, left, right, full. | +| `p10k_prompt_spacing` | `"compact"` | Prompt spacing. Valid values: compact, sparse. | +| `p10k_prompt_flow` | `"concise"` | Prompt flow. Valid values: concise, fluent. | +| `p10k_transient_prompt` | `"no"` | Enable or disable transient prompt. Valid values: yes, no. | -```yaml ---- -# defaults file for ansible-role-p10k - -# Powerlevel10k Git repository url -p10k_repository_url: 'https://github.com/romkatv/powerlevel10k.git' - -# Install p10k for the following linux users -# Default: the linux user running Ansible -p10k_users: - - "{{ ansible_user_id }}" - -# Zsh plugin used, zsh, ohmyzsh, prezto, Zim, etc.. -# All plugin names can be found here https://github.com/romkatv/powerlevel10k#installation -zsh_plugin: zsh - -# Setup p10k theme to use -# Valid values: lean, classic, rainbow, pure -p10k_prompt_style: "classic" - -# Show current time -# Valid values: no, 24-hour, 12-hour -p10k_prompt_time: "24-hour" - -# Prompt sperator -# Valid values: angled, vertical, slanted, round -p10k_prompt_separator: "angled" - -# Prompt heads -# Valid values: sharp, blurred, slanted, round -p10k_prompt_head: "sharp" - -# Prompt tails -# Valid values: flat, blurred, sharp, slanted, round -p10k_prompt_tails: flat - -# Terminal prompt height -# Valid values: one-line, two-lines -p10k_prompt_height: two-lines - -# Prompt connection, only used if "p10k_prompt_height" value is "two-lines" -# Valid values: disconnected, dotted, solid -p10k_prompt_connection: disconnected - -# Prompt connection color, only used if -# "p10k_prompt_connection" value is "dotted" or "solid" -# or "p10k_prompt_frame" is not "no" -# Valid values: lightest, light, dark, darkest, black, white, green, blue -p10k_prompt_connection_color: "dark" - -# Prompt frame connection -# Valid values: no, left, right, full -p10k_prompt_frame: left - -# Sparse prompt with an empty line before promp -# Valid values: compact, sparse -p10k_prompt_spacing: compact - -# Terminal flow -# Valid values: concise, fluent -p10k_prompt_flow: concise - -# Enable transient prompt -# Valid values: yes, no -p10k_transient_prompt: "no" -``` ### Sources: - https://github.com/diodonfrost/ansible-role-p10k/tree/master