From e05637ded103b244c219659f3be8fedb3ce58372 Mon Sep 17 00:00:00 2001 From: Ajeet D'Souza <98ajeet@gmail.com> Date: Mon, 8 May 2023 22:40:04 +0530 Subject: [PATCH] Improve clarity of setup instructions --- README.md | 22 ++++++++++++---------- man/man1/zoxide-init.1 | 22 ++++++++++++---------- 2 files changed, 24 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 16e1fbd..586ff59 100644 --- a/README.md +++ b/README.md @@ -172,7 +172,7 @@ zoxide can be installed in 4 easy steps:
Bash - > Add this to your configuration (usually `~/.bashrc`): + > Add this to the **end** of your config file (usually `~/.bashrc`): > > ```sh > eval "$(zoxide init bash)" @@ -183,7 +183,7 @@ zoxide can be installed in 4 easy steps:
Elvish - > Add this to your configuration (usually `~/.elvish/rc.elv`): + > Add this to the **end** of your config file (usually `~/.elvish/rc.elv`): > > ```sh > eval (zoxide init elvish | slurp) @@ -197,7 +197,8 @@ zoxide can be installed in 4 easy steps:
Fish - > Add this to your configuration (usually `~/.config/fish/config.fish`): + > Add this to the **end** of your config file (usually + > `~/.config/fish/config.fish`): > > ```fish > zoxide init fish | source @@ -208,13 +209,14 @@ zoxide can be installed in 4 easy steps:
Nushell - > Add this to your env file (find it by running `$nu.env-path` in Nushell): + > Add this to the **end** of your env file (find it by running `$nu.env-path` + > in Nushell): > > ```sh > zoxide init nushell | save -f ~/.zoxide.nu > ``` > - > Now, add this to the end of your config file (find it by running + > Now, add this to the **end** of your config file (find it by running > `$nu.config-path` in Nushell): > > ```sh @@ -229,8 +231,8 @@ zoxide can be installed in 4 easy steps:
PowerShell - > Add this to your configuration (find it by running `echo $profile` in - > PowerShell): + > Add this to the **end** of your config file (find it by running + > `echo $profile` in PowerShell): > > ```powershell > Invoke-Expression (& { (zoxide init powershell | Out-String) }) @@ -241,7 +243,7 @@ zoxide can be installed in 4 easy steps:
Xonsh - > Add this to your configuration (usually `~/.xonshrc`): + > Add this to the **end** of your config file (usually `~/.xonshrc`): > > ```python > execx($(zoxide init xonsh), 'exec', __xonsh__.ctx, filename='zoxide') @@ -252,7 +254,7 @@ zoxide can be installed in 4 easy steps:
Zsh - > Add this to your configuration (usually `~/.zshrc`): + > Add this to the **end** of your config file (usually `~/.zshrc`): > > ```sh > eval "$(zoxide init zsh)" @@ -267,7 +269,7 @@ zoxide can be installed in 4 easy steps:
Any POSIX shell - > Add this to your configuration: + > Add this to the **end** of your config file: > > ```sh > eval "$(zoxide init posix --hook prompt)" diff --git a/man/man1/zoxide-init.1 b/man/man1/zoxide-init.1 index 0a44b51..ee77216 100644 --- a/man/man1/zoxide-init.1 +++ b/man/man1/zoxide-init.1 @@ -7,14 +7,14 @@ To initialize zoxide on your shell: .TP .B bash -Add this to your configuration (usually \fB~/.bashrc\fR): +Add this to the \fBend\fR of your config file (usually \fB~/.bashrc\fR): .sp .nf \fBeval "$(zoxide init bash)"\fR .fi .TP .B elvish -Add this to your configuration (usually \fB~/.elvish/rc.elv\fR): +Add this to the \fBend\fR of your config file (usually \fB~/.elvish/rc.elv\fR): .sp .nf \fBeval $(zoxide init elvish | slurp)\fR @@ -23,20 +23,22 @@ Add this to your configuration (usually \fB~/.elvish/rc.elv\fR): Note: zoxide only supports elvish v0.18.0 and above. .TP .B fish -Add this to your configuration (usually \fB~/.config/fish/config.fish\fR): +Add this to the \fBend\fR of your config file (usually +\fB~/.config/fish/config.fish\fR): .sp .nf \fBzoxide init fish | source\fR .fi .TP .B nushell -Add this to your env file (find it by running \fB$nu.env-path\fR in Nushell): +Add this to the \fBend\fR of your env file (find it by running +\fB$nu.env-path\fR in Nushell): .sp .nf \fBzoxide init nushell | save -f ~/.zoxide.nu\fR .fi .sp -Now, add this to the end of your config file (find it by running +Now, add this to the \fBend\fR of your config file (find it by running \fB$nu.config-path\fR in Nushell): .sp .nf @@ -46,22 +48,22 @@ Now, add this to the end of your config file (find it by running Note: zoxide only supports Nushell v0.73.0 and above. .TP .B powershell -Add this to your configuration (find it by running \fBecho $profile\fR in -PowerShell): +Add this to the \fBend\fR of your config file (find it by running \fBecho +$profile\fR in PowerShell): .sp .nf \fBInvoke-Expression (& { (zoxide init powershell | Out-String) })\fR .fi .TP .B xonsh -Add this to your configuration (usually \fB~/.xonshrc\fR): +Add this to the \fBend\fR of your config file (usually \fB~/.xonshrc\fR): .sp .nf \fBexecx($(zoxide init xonsh), 'exec', __xonsh__.ctx, filename='zoxide')\fR .fi .TP .B zsh -Add this to your configuration (usually \fB~/.zshrc\fR): +Add this to the \fBend\fR of your config file (usually \fB~/.zshrc\fR): .sp .nf \fBeval "$(zoxide init zsh)"\fR @@ -69,7 +71,7 @@ Add this to your configuration (usually \fB~/.zshrc\fR): .TP .B any POSIX shell .sp -Add this to your configuration: +Add this to the \fBend\fR of your config file: .sp .nf \fBeval "$(zoxide init posix --hook prompt)"\fR