diff options
author | Canop <cano.petrole@gmail.com> | 2020-03-29 12:59:44 +0200 |
---|---|---|
committer | Canop <cano.petrole@gmail.com> | 2020-03-29 12:59:44 +0200 |
commit | 452dd38cc22aa66f11c2377eaafca521871d1184 (patch) | |
tree | 3af16c95dc6010d9019ce8ea22c5a204ac0bc36f /website/docs/install.md | |
parent | df9e4999b320be0458dbde11c60881014927f107 (diff) |
website: make the install page independant
so that it is more easily found
Diffstat (limited to 'website/docs/install.md')
-rw-r--r-- | website/docs/install.md | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/website/docs/install.md b/website/docs/install.md new file mode 100644 index 0000000..cf24433 --- /dev/null +++ b/website/docs/install.md @@ -0,0 +1,76 @@ + +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. + +!!! Note + If you use cargo and there's a compilation error, it usually means you have an old version of the compiler, and you should update it (for example with `rustup update`). + +# From precompiled binaries + +Binaries are made available at every release in [download](https://dystroy.org/broot/download). + +Direct links: + +Target|Files +-|- +Linux | [x86_64-linux](https://dystroy.org/broot/download/x86_64-linux/broot) +Raspberry | [armv7-unknown-linux-gnueabihf](https://dystroy.org/broot/download/armv7-unknown-linux-gnueabihf/broot) +Windows 10+ | [x86_64-pc-windows-gnu](https://dystroy.org/broot/download/x86_64-pc-windows-gnu/broot.exe) +Shell completion | [completion/](https://dystroy.org/broot/download/completion/) + +You may download previous releases on [GitHub releases](https://github.com/Canop/broot/releases). + +When you download executable files, you'll have to ensure the shell can find them. An easy solution on linux is for example to put them in `/usr/local/bin`. You may also have to set them executable using `chmod +x broot`. + +# From crates.io + +You'll need to have the [Rust development environment](https://www.rust-lang.org/tools/install) installed. + +Once it's installed, use cargo to install broot: + + cargo install broot + +# From source + +You'll need to have the [Rust development environment](https://www.rust-lang.org/tools/install) installed. + +Fetch the [Canop/broot](https://github.com/Canop/broot) repository, move to the broot directory, then run + + cargo install --path . + + +# Homebrew + +If you're using [homebrew](https://brew.sh/), you can use the `brew install` command: + + brew install broot + +*note: the brew formula is maintained by a third party and may be less up to date.* + +# APT / Deb + +Ubuntu and Debian users may use this apt repository: [https://packages.azlux.fr/](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 `<alt><enter>` or `:cd`. + +But broot needs a companion function in the shell in order to be able to change directory. + +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. + +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`. + +When it's done, you can do just `br` to launch broot, and typing `<alt><enter>` will cd for you. + + |