summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorCanop <cano.petrole@gmail.com>2019-02-05 17:12:42 +0100
committerCanop <cano.petrole@gmail.com>2019-02-05 17:12:42 +0100
commit2271d6755bdffc591f1945c0a5da40a689227fe5 (patch)
tree468388799f7b61c7df7a10261c259574eff96be4 /README.md
parentc8c0b972b51a7361022fbe977a326c7dbd7930f7 (diff)
parent7e0b7e6c5e8ef8ea2eb7ae0c7404697377d98394 (diff)
Merge remote-tracking branch 'origin/master'
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 13 insertions, 10 deletions
diff --git a/README.md b/README.md
index d632b17..dbc6913 100644
--- a/README.md
+++ b/README.md
@@ -10,17 +10,17 @@ A better way to navigate directories.
![overview](img/20190128-overview.png)
-Notice the "unlisted" ? That's what makes it usable where the old `tree` command would produce pages of output.
+Notice the "unlisted"? That's what makes it usable where the old `tree` command would produce pages of output.
-.gitignore files are properly dealt with to put unwanted files out of your way (you can ignore them, though, see documentation).
+`.gitignore` files are properly dealt with to put unwanted files out of your way (you can ignore them though, see documentation).
### Find a directory then `cd` to it:
![cd](img/20190128-cd.png)
-You can this way navigate to a directory with the minimum amount of keystrokes, even if you don't exactly remember where it is.
+This way, you can navigate to a directory with the minimum amount of keystrokes, even if you don't exactly remember where it is.
-broot is fast and never blocks, even when you make it search a big slow disk (any keystroke interrupts the current search to start the following one).
+broot is fast and never blocks, even when you make it search a big slow disk (any keystroke interrupts the current search to start the next one).
Most useful keys for this:
@@ -40,15 +40,15 @@ You may also search with a regular expression. To do this, add a `/` before or a
Complex regular expression are possible, but you'll probably most often use a regex to do an "exact" search, or search an expression at the start or end of the filename.
-For example, assuming you look for your one file whose name contains `"abc"` in a big directory, you may not see it immediately because of many fuzzy matches. In that case, just add a slash at the end to change you fuzzy search into an exact expression: `abc/`.
+For example, assuming you look for your one file whose name contains `abc` in a big directory, you may not see it immediately because of many fuzzy matches. In that case, just add a slash at the end to change you fuzzy search into an exact expression: `abc/`.
-And if you look for a filename *ending* in `"abc"` then you may anchor the regex: `abc$/`.
+And if you look for a filename *ending* in `abc` then you may anchor the regex: `abc$/`.
### See what takes space:
![size](img/20190128-only-folders-with-size.png)
-To toggle size display, you usually hit `:s`. Sizes are computed in the background, you don't have to wait for them when you navigate.
+To toggle size display, type `:s`. Sizes are computed in the background, you don't have to wait for them when you navigate.
### Apply a personal shortcut to a file:
@@ -63,8 +63,11 @@ 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
@@ -111,14 +114,14 @@ But broot needs a companion function in the shell in order to be able to change
fi
}
-(you'll have to source the file or open a new terminal)
+(You'll have to source the `.bashrc` file or open a new terminal for the function to take effect.)
With this addition, you can do just `br` to launch broot, and typing `<alt><enter>` will cd for you.
## Development
-To ease tests during development, a log file can be generated (and followed using tail -f) by using the BROOT_LOG env variable.
+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:
@@ -128,6 +131,6 @@ 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/3?Code_et_Croissants). Before to start coding for a PR, it would really be a good idea to come and talk about it.
+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.
If you'd like a new feature, don't hesitate to ask for it.