summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCanop <cano.petrole@gmail.com>2019-01-07 14:03:57 +0100
committerCanop <cano.petrole@gmail.com>2019-01-07 14:03:57 +0100
commit22c36ba7f987452ad0cdde9dd923fefe61ad3a66 (patch)
treebf76367025a81427acfd518e1ed8651adfbbfb77
parent5b2b2449497f906258b5590fe70f938b7edbfb02 (diff)
parentb8216cc55aa4da026e122387ffeda1bed07303df (diff)
Merge remote-tracking branch 'origin/master'v0.4.1
-rw-r--r--README.md28
1 files changed, 22 insertions, 6 deletions
diff --git a/README.md b/README.md
index 85aceac..03c69d6 100644
--- a/README.md
+++ b/README.md
@@ -4,27 +4,43 @@
An interactive tree view, a fuzzy search, a balanced BFS descent and customizable commands.
-Get an overview of a directory, even a big one:
+### Get an overview of a directory, even a big one:
![overview](doc/20181215-overview.png)
-Find a directory then `cd` to it:
+Notice the "unlisted" ? That's what makes it usable where the old `tree` command would produce pages of output.
+
+### Find a directory then `cd` to it:
![cd](doc/20181218-cd.png)
-See what takes space:
+You can this way navigate to a directory with the minimum amount of keystrokes, even if you don't exactly remember where it is.
+
+Most useful keys for this:
+
+* the letters of what you're looking for
+* `<enter>` to select a directory (staying in broot)
+* `<esc>` to get back to the previous state or clear your search
+* `:c` to get back to the shell having cd to the selected directory ([see below](#use-broot-for-navigation))
+* `:q` if you just want to quit (`<esc>` works too)
+
+### See what takes space:
![size](doc/20181215-only-folders-with-size.png)
-Never lose track of file hierarchy while you fuzzy search:
+To toggle size display, you usually hit `:s`.
+
+### Never lose track of file hierarchy while you fuzzy search:
![size](doc/20181215-search.png)
-Apply a personal shorcut to a file:
+broot tries to select the most relevant file. You can still go from one match to another one using `<tab>` or arrow keys.
+
+### Apply a personal shorcut to a file:
![size](doc/20181215-edit.png)
-broot is fast and never blocks, even when you make it search a big slow disk.
+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).
## Usage