From e05595865b5b091f709795d71a44aac78d461b0c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Denys=20S=C3=A9guret?= Date: Mon, 7 Jan 2019 09:33:20 +0100 Subject: some clarifications in the readme --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 85aceac..e77aa43 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,14 @@ Get an overview of a directory, even a big one: ![overview](doc/20181215-overview.png) +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) +You can this way navigate to a directory with the minimum amount of keystrokes, even if you don't exactly remember where it is. + See what takes space: ![size](doc/20181215-only-folders-with-size.png) @@ -20,11 +24,13 @@ Never lose track of file hierarchy while you fuzzy search: ![size](doc/20181215-search.png) +broot tries to select the most relevant file. You can still go from one match to another one using 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 -- cgit v1.2.3 From b8216cc55aa4da026e122387ffeda1bed07303df Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Denys=20S=C3=A9guret?= Date: Mon, 7 Jan 2019 09:46:35 +0100 Subject: some complements to the readme --- README.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e77aa43..03c69d6 100644 --- a/README.md +++ b/README.md @@ -4,29 +4,39 @@ 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) 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: +### Find a directory then `cd` to it: ![cd](doc/20181218-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. -See what takes space: +Most useful keys for this: + +* the letters of what you're looking for +* `` to select a directory (staying in broot) +* `` 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 (`` 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) -broot tries to select the most relevant file. You can still go from one match to another one using or arrow keys. +broot tries to select the most relevant file. You can still go from one match to another one using `` or arrow keys. -Apply a personal shorcut to a file: +### Apply a personal shorcut to a file: ![size](doc/20181215-edit.png) -- cgit v1.2.3