diff options
| author | Canop <cano.petrole@gmail.com> | 2019-03-07 20:41:49 +0100 |
|---|---|---|
| committer | Canop <cano.petrole@gmail.com> | 2019-03-07 20:41:49 +0100 |
| commit | f7f1ca0dc436ed9e0a9129f9444f174a82777bcb (patch) | |
| tree | 8ea86a05f4fdbae41a96c3961352d249f9f60628 /README.md | |
| parent | f2de057e45ee5bae8ddccb7f4db998bafe8e1947 (diff) | |
new documentation website
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 57 |
1 files changed, 5 insertions, 52 deletions
@@ -2,9 +2,11 @@ [](https://travis-ci.org/Canop/broot) [](https://miaou.dystroy.org/3490?broot) -[](https://miaou.dystroy.org/3490?broot) +[](https://miaou.dystroy.org/3) -A better way to navigate directories. +A better way to navigate directories + +[**Broot's Web Site**](https://dystroy.org/broot) ### Get an overview of a directory, even a big one: @@ -58,54 +60,5 @@ Just find the file you want to edit with a few keystrokes, type `:e`, then `<ent ### More... -See the complete [Documentation](documentation.md). - -## Installation - -### Compile - -You'll need to have the [Rust development environment](https://www.rust-lang.org/tools/install) installed. - -#### From crates.io - - cargo install broot - -#### From Source - -Fetch the Canop/broot repository, move to the broot directory, then run - - cargo build --release - -The executable is written in the `target/release` directory (you might want to move it to your `/usr/bin`, or to add the release directory to your path). - -Building from the repository, you'll get the most recent version... and the least tested one. - -### From up to date precompiled binaries - -* [x86_64-linux](https://dystroy.org/broot/x86_64-linux/broot) - -### 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. - -To enable this feature, broot asks the permission to register this shell function on first run. - -When it's done, you can do just `br` to launch broot, and typing `<alt><enter>` will cd for you. - -## Development - -To make tests easier during development, a log file can be generated (and followed using `tail -f`) by using the BROOT_LOG environment variable. - -For example: - - BROOT_LOG=debug cargo run - -or - - BROOT_LOG=info cargo run - -If you want to discuss the code or features of broot, please come to [our chat](https://miaou.dystroy.org/3490?broot). Before you start coding for a PR, it would really be a good idea to come and talk about it. +See [Broot's web site](https://dystroy.org/broot) for instructions regarding installation and usage. -If you'd like a new feature, don't hesitate to ask for it. |