From d94a0fda985523adc85f80ede8f97b9a34798102 Mon Sep 17 00:00:00 2001 From: marcelarie Date: Thu, 17 Oct 2024 17:40:56 +0200 Subject: [PATCH] improve README.md --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a0cd7cd..91a701d 100644 --- a/README.md +++ b/README.md @@ -30,12 +30,22 @@ Add this to the end of your `env.nu` file (find it by running `$nu.env-path` in nu-alias-converter ~/.bash_aliases -o $"($nu.default-config-dir)/bash-alises.nu" | ignore ``` -This will make the aliases available in the Nushell environment. +Now add this to your `config.nu` to source the generated aliases file (find the path +with `nu.config-path`): + +```nushell +source .bash_aliases.nu +``` + +This will make the bash aliases available in the Nushell environment. ### Ignoring Aliases +Sometimes there are some aliases that you don't want to convert to Nushell, +maybe because they are not valid or you don't want to use them in Nushell. + You can ignore aliases by adding them to a `.aliasignore` file in the root of -your home directory or in the nushell config directory. +your home directory or in the nushell config directory. The file should contain all the aliases that should be ignored, one per line: @@ -129,6 +139,8 @@ graph TD - [x] Add `.alias_ignore` file to skip certain aliases during conversion - [x] Ignore aliases by name - [x] Ignore aliases by command + - [x] Check for .alias_ignore in the current directory + - [ ] Check for .alias_ignore in nu config directory - [x] Handle cases when no aliases are found in the file - [x] Handle empty files