ls: Add support for "lscolors.sh"

[ax-zsh.git] / README.md

diff --git a/README.md b/README.md
index b74e84d3ca74cb2c2d36336cd68ab2680d94997d..63bcfee6d8c21525779b9f0bb1b24c3cd6feda14 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,15 +6,11 @@ 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.
-Afterwards use the `install.sh` script inside of the source directory to set
-up the `~/.axzsh` directory.
-
 The homepage of [AX-ZSH] can be found at [GitHub]:
 <https://github.com/alexbarton/ax-zsh>.
 
+## Installation
+
 Prerequisites:
 
 * [ZSH] – obviously ;-)
@@ -22,25 +18,17 @@ Prerequisites:
 
 Installing AX-ZSH is a two-step process:
 
-1. Clone or copy the source files into `~/.axzsh`,
+1. Clone or copy the source files into the `~/.axzsh` directory,
 2. Run the `~/.axzsh/install.sh` script.
 
 The `install.sh` script creates symbolic links for `~/.zprofile`, `~/.zshrc`,
 `~/.zlogin`, and `~/.zlogout` (don't worry, already existing files are backed
 up).
 
-Then close all running ZSH sessions and restart them to activate AX-ZSH. And
-maybe change your default shell to ZSH if you haven't already?
-
-For example like this:
-
-```sh
-# Set new default shell
-chsh -s $(command -v zsh)
-
-# Replace running shell with a ZSH login shell
-exec $(command -v zsh) -l
-```
+*Note:* The installation is per-user and only changes/installs files into the
+home directory of the current user (`~`). AX-ZSH is not meant to be installed
+globally for all users on a system at once, and you don't need to become "root"
+or any other user with elevated privileges!
 
 ### Installation using Git
 
@@ -57,7 +45,7 @@ git clone https://github.com/alexbarton/ax-zsh.git ~/.axzsh
 
 *Note:* If you do not install AX-ZSH with [Git], you will not be able to upgrade
 itself afterwards with the integrated `axzsh upgrade` command! Therefore this
-method is _not recommended_ for normal use!
+method is *not recommended* for normal use!
 
 ```sh
 curl -Lo ax-zsh-master.zip https://github.com/alexbarton/ax-zsh/archive/refs/heads/master.zip
@@ -66,6 +54,22 @@ mv ax-zsh-master ~/.axzsh
 ~/.axzsh/install.sh
 ```
 
+### Post-Installation Tasks
+
+After installing AX-ZSH, using Git or via an archive file, you should close all
+running ZSH sessions and restart them to activate AX-ZSH. And maybe you want to
+change your default shell to ZSH if you haven't already?
+
+For example like this:
+
+```sh
+# Set new default shell
+chsh -s $(command -v zsh)
+
+# Replace running shell with a ZSH login shell
+exec $(command -v zsh) -l
+```
+
 ## Upgrade
 
 When you used Git to install AX-ZSH (and/or plugins), you can use the `axzshctl`
@@ -123,7 +127,7 @@ strengths when enabling additional plugins for additional tools and commands
 that are available on your system and you want to use.
 
 Different types of plugins are supported (see the introduction to the section
-"_usage_" above) which are differentiated by their identifier:
+"*usage*" above) which are differentiated by their identifier:
 
 * `<name>`: locally available plugin, either bundled with AX-ZSH itself, or
   installed manually (see below).
@@ -137,7 +141,7 @@ You can enable one or more plugins like this:
 axzshctl enable-plugin <identifier> [<identifier> […]]
 ```
 
-*Hint:* _Tab-completion_ works for sub-commands and already locally available
+*Hint:* *Tab-completion* works for sub-commands and already locally available
 plugin names!
 
 Some examples:
@@ -176,7 +180,7 @@ Run the following command to disable a currently enabled plugin:
 axzshctl disable-plugin <identifier> [<identifier> […]]
 ```
 
-*Hint:* _Tab-completion_ works for sub-commands and plugin names!
+*Hint:* *Tab-completion* works for sub-commands and plugin names!
 
 ### Update plugin cache
 
@@ -261,4 +265,4 @@ ___
 [Powerlevel10k]: <https://github.com/romkatv/powerlevel10k> "Powerlevel10k Homepage"
 [ZSH]: <https://www.zsh.org/> "ZSH Homepage"
 
-[AX-ZSH] Copyright (c) 2015-2021 Alexander Barton <alex@barton.de>
+[AX-ZSH] Copyright (c) 2015-2022 Alexander Barton <alex@barton.de>