summaryrefslogtreecommitdiffstats
path: root/website/docs/install.md
diff options
context:
space:
mode:
authorCanop <cano.petrole@gmail.com>2020-07-09 21:19:48 +0200
committerCanop <cano.petrole@gmail.com>2020-07-09 21:19:48 +0200
commita3a4c81053f8d7b5521d2dafd7cb852b7e5c12eb (patch)
tree6192e9b4f046650a0e04b1be8e4899c25601b158 /website/docs/install.md
parentd094c44ca6032fdc7f8c2da4bd31bc0aaeaa8adc (diff)
split of the install doc page, addition of a "common problems" one
Diffstat (limited to 'website/docs/install.md')
-rw-r--r--website/docs/install.md55
1 files changed, 2 insertions, 53 deletions
diff --git a/website/docs/install.md b/website/docs/install.md
index d6c5155..5a7bc93 100644
--- a/website/docs/install.md
+++ b/website/docs/install.md
@@ -1,7 +1,6 @@
The current version of broot works on linux, mac and windows (win 10+).
-
!!! Note
**Windows users:** broot may need additional rights at first use in order to write its configuration file.
Some users on Windows also report problems with the colon. Remember that a space can be used instead of a colon.
@@ -59,57 +58,7 @@ Ubuntu and Debian users may use this apt repository: [https://packages.azlux.fr/
*note: this repository is also maintained by a third party.*
-# Installation Completion : the `br` shell function
-
-broot is convenient to find a directory then `cd` to it, which is done using <kbd>alt</kbd><kbd>enter</kbd> or `:cd`.
-
-But broot needs a companion function in the shell in order to be able to change directory.
-
-## Automatic shell function installation
-
-This is normally the easiest solution and it's safe.
-
-When you start broot, it checks whether the `br` shell function seems to have been installed (or
-to have been refused). If needed, and if the used shell seems compatible (supported shells today are bash, zsh and fish),
-then broot asks the permission to register this shell function.
-
-When it's done, you can do `br` to launch broot, and typing <kbd>alt</kbd><kbd>enter</kbd> will cd for you.
-
-## Retry the automatic installation
-
-If you have messed with the configuration files, you might want to have the shell function reinstalled.
-
-In order to do this, either remove all broot config files, or launch `broot --install`.
-
-You can also use the `--install` argument when you first refused and then decided you want it installed.
-
-## Manual shell function installation
-
-If you prefer to manage the function sourcing yourself, or to automate the installation your way, or if you use an unsupported configuration, you still can get some help of broot:
-
-`broot --print-shell-function bash` (you can replace `bash` with either `zsh` or `fish`) outputs a recommended shell function.
-
-`broot --set-install-state installed` tells broot the `br` function is installed (other possible values are `undefined` and `refused`).
-
-## `br` alias for Nushell
-
-As a shortcut for [Nushell](https://www.nushell.sh/), define the following alias:
-
- alias br [] { broot | trim | cd $it }
-
-You can bind this command to a key sequence in the [configuration file](../conf_file):
-
-```toml
-[[verbs]]
-key = "alt-c"
-shortcut = "pp"
-execution = ":print_path"
-```
-
-# Fix the colors
-
-Broot's initial colors ensure that everything is readable whathever your settings.
-But you may want to have something more similar to your usual terminal colors, or maybe to define the whole skin.
-You should probably have a look at [changing the skin](../skins) as your next step.
+-----------------------------------
+Now you should [install the br shell function](../install-br/).