From a73a7756d730e4b803ffbdf27b8e62b4b821dd8b Mon Sep 17 00:00:00 2001 From: Alexander Barton Date: Fri, 10 Dec 2021 21:54:33 +0100 Subject: [PATCH] README.md: Add "integration with other projects" section And mention Powerlevel10k support! --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 3f7feda..b74e84d 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,9 @@ [AX-ZSH] is a modular configuration system for the Z shell ([ZSH]). It provides sane defaults and is extendable by plugins. +AX-ZSH integrates well with [Powerlevel10k] and other extensions, even plugins +of [OhMyZsh], see [below](#integration-with-other-projects). + ## Installation To install AX-ZSH, either download a source archive or use [Git] to clone it. @@ -199,6 +202,21 @@ Please run `axzshctl --help` to get a full list of a available sub-commands: axzshctl --help ``` +## Integration with other projects + +### Powerlevel10k + +AX-ZSH supports [Powerlevel10k] out of the box, you just have to install it as a +plugin: + +```sh +axzshctl enable-plugin romkatv/powerlevel10k +``` + +*Hint:* Once the Powerlevel10k plugin theme is installed, you can use the +regular `axzshctl set-theme` command to enable it, like for any other installed +theme: `axzshctl set-theme powerlevel10k`. + ## AX-ZSH & local ZSH configuration Don't modify `~/.zprofile`, `~/.zshrc`, `~/.zlogin`, or `~/.zlogout`! These @@ -240,6 +258,7 @@ ___ [Git]: "Git Homepage" [GitHub]: "GitHub Homepage" [OhMyZsh]: "OhMyZsh Homepage" +[Powerlevel10k]: "Powerlevel10k Homepage" [ZSH]: "ZSH Homepage" [AX-ZSH] Copyright (c) 2015-2021 Alexander Barton -- 2.39.2