Skip to content

Commit

Permalink
mention alt-enter in readme and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Canop committed Feb 3, 2019
1 parent 8d29a5d commit 71e1021
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 4 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ notes.md
**/*.rs.bk
perf.data*
*.pl
off

6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ 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))
* `<alt><enter>` 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)

### Never lose track of file hierarchy while you fuzzy search:
Expand Down Expand Up @@ -81,7 +81,7 @@ The executable is written in the `target/release` directory (you might want to m

## cd

broot is convenient to find a directory then `cd` to it. The `c` command of the default configuration is here for this purpose.
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, add this to your `.bashrc` (or the relevant file for another shell):

Expand Down Expand Up @@ -113,7 +113,7 @@ But broot needs a companion function in the shell in order to be able to change

(you'll have to source the file or open a new terminal)

With this addition, you can do just `br` to launch broot, and typing `:c` then *enter* will cd for you. You can search and change directory in one command: `mylosthing:c`.
With this addition, you can do just `br` to launch broot, and typing `<alt><enter>` will cd for you.


## Development
Expand Down
4 changes: 3 additions & 1 deletion documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,9 @@ This is normally achieved with the `esc` key but you might want to remap it.

`:cd` is the most useful verb but only works if you're using the [shell integration](README.md#use-broot-for-navigation).

In the default configuration it's mapped to `c`.
If you call it on a simple file, instead of a directory, the shell will be directed to the parent direcory.

It's mapped to `<alt><enter>`.

### `:focus` : change the tree's root

Expand Down

0 comments on commit 71e1021

Please sign in to comment.