Skip to content

Commit

Permalink
Update build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
mgunyho committed Jul 15, 2022
1 parent 73f7281 commit 95965c4
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,13 @@ Currently, `tere` is tested on and built for Ubuntu. On Mac, it should be enough
To compile `tere` from source, follow the standard procedure:
1. Clone the repo
1. [Install the Rust toolchain](https://www.rust-lang.org/tools/install)
1. `git clone [email protected]:mgunyho/tere.git`
1. `cd tere`
1. Run `cargo build` (`--release` for the release version)
This will place the `tere` in the folder `target/debug` or `target/release` if you used `--release`.
## User guide
You can navigate folders in `tere` by using the arrow keys and by typing to search. Basic navigation works by moving the cursor up or down, and pressing <kbd>Enter</kbd> or the right arrow <kbd>→</kbd> to enter the highlighted folder. You can move to the parent folder by pressing <kbd>Enter</kbd> on the parent folder item `..`, or with the left arrow <kbd>←</kbd>. Below is a full list of keyboard shortcuts.
Expand Down

0 comments on commit 95965c4

Please sign in to comment.