From 0d6859cae8d622be48b83a0ac9784ea2423c8089 Mon Sep 17 00:00:00 2001 From: romkatv Date: Fri, 31 Jan 2020 14:12:30 +0100 Subject: [PATCH] add configuration wizard tips --- README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 50 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5e81369..a0ca91e 100644 --- a/README.md +++ b/README.md @@ -111,7 +111,7 @@ Powerlevel10k can produce the same prompt as [Pure](https://github.com/sindresor ![Powerlevel10k Pure Style]( https://raw.githubusercontent.com/romkatv/powerlevel10k-media/master/pure-style.gif) -You can still use Powerlevel10k features such as [transient Prompt](#transient-prompt) or +You can still use Powerlevel10k features such as [transient prompt](#transient-prompt) or [instant Prompt](#instant-prompt) when sporting Pure style. To customize prompt, edit `~/.p10k.zsh`. Powerlevel10k doesn't recognize Pure configuration @@ -178,7 +178,7 @@ prompt when accepting a command line. Transient prompt makes it much easier to copy-paste series of commands from the terminal scrollback. -*Tip*: If you enable Transient Prompt, take advantage of two-line prompt. You'll get the benefit of +*Tip*: If you enable transient prompt, take advantage of two-line prompt. You'll get the benefit of extra space for typing commands without the usual drawback of reduced scrollback density. ### Current directory that just works @@ -447,6 +447,18 @@ Powerlevel10k is released under the ## FAQ +### Which aspects of shell and terminal does Powerlevel10k affect? + +Powerlevel10k defines prompt and nothing else. It sets prompt-related options (their names start +`prompt`), and parameters `PS1` and `RPS1`. + +Powerlevel10k does not affect: + +- Terminal window title. +- Colors used by `ls`. +- Command line colors (syntax highlighting). +- Prompt parameters other than `PS1` and `RPS1`. + ### I'm using Powerlevel9k with Oh My Zsh. How do I migrate? 1. Run this command: @@ -769,6 +781,39 @@ Almost. There are a few differences. If you notice any other changes in prompt appearance when switching from Powerlevel9k to Powerlevel10k, please [open an issue](https://github.com/romkatv/powerlevel10k/issues). +### What is the best prompt style in the configuration wizard? + +There are as many opinions on what constitutes the best prompt as there are people. It mostly comes +down to personal preference. There are, however, a few hidden implications of different choices. + +Pure style is an exact replication of [Pure Zsh theme](https://github.com/sindresorhus/pure). It +exists to ease the migration for users of this theme. Unless you are one of them, choose Lean +style over Pure. + +If you want to confine prompt colors to the selected terminal color palette (say, *Solarized Dark*), +use *Rainbow*, *Lean* → *8 colors* or *Pure* → *Original*. Other styles use fixed colors and thus +look the same in any terminal color palette. + +If you enable transient prompt, take advantage of two-line prompt. You'll get the benefit of +extra space for typing commands without the usual drawback of reduced scrollback density. Having +all commands start from the same offset is also nice. + +Similarly, if you enable transient prompt, sparse prompt (with an empty line before prompt) is a +great choice. + +If you are using vi keymap, choose prompt with `prompt_char` in it (shown as green `❯` in the +wizard). This symbol changes depending on vi mode: `❯`, `❮`, `Ⅴ`, `▶` for insert, command, visual +and replace mode respectively. When a command fails, the symbol turns red. *Lean* style always has +`prompt_char` in it. *Rainbow* and *Classic* styles have it only in the two-line configuration +without left frame. + +If you value horizontal space or prefer minimalist aesthetics, disable *current time* and use *few +icons*. The extra icons enabled by the *many icons* option primarily serve decorative function. +Informative icons, such as background job indicator, will be shown either way. + +*Note*: You can run configuration wizard as many times as you like. Type `p10k configure` to try new +prompt style. + ### Is there an AUR package for Powerlevel10k? Yes, [zsh-theme-powerlevel10k-git](https://aur.archlinux.org/packages/zsh-theme-powerlevel10k-git/). @@ -787,6 +832,9 @@ custom background color (`#171A1B` instead of `#2E3436` -- twice as dark). ![GNOME Terminal Color Settings]( https://raw.githubusercontent.com/romkatv/powerlevel10k-media/master/gnome-terminal-colors.png) +Syntax highlighting, where present, was provided by [zsh-syntax-highlighting]( + https://github.com/zsh-users/zsh-syntax-highlighting). + ## Troubleshooting ### Question mark in prompt