summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md1
-rw-r--r--website/docs/community.md9
-rw-r--r--website/docs/documentation/configuration.md2
-rw-r--r--website/docs/img/20200203-git.pngbin0 -> 37222 bytes
-rw-r--r--website/docs/index.md3
5 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
index f013e0c..8580e40 100644
--- a/README.md
+++ b/README.md
@@ -29,6 +29,7 @@ Table of Contents
* [Apply a standard or personal shortcut to a file](#apply-a-standard-or-personal-shortcut-to-a-file)
* [Replace `ls` (and its clones)](#replace-ls-and-its-clones)
* [See what takes space](#see-what-takes-space)
+ * [Check git statuses](#check-git-statuses)
* [Further Reading](#further-reading)
## Installation
diff --git a/website/docs/community.md b/website/docs/community.md
index acef951..7b340cd 100644
--- a/website/docs/community.md
+++ b/website/docs/community.md
@@ -19,6 +19,15 @@ We use [GitHub's issue manager](https://github.com/Canop/broot/issues).
Before posting a new issue, check your problem hasn't already been raised and in case of doubt **please come first discuss it on the chat**.
+### Log
+
+When something looks like a bug, especially keyboard problems, we need both to know the exact configuration (OS, terminal program, mainly) and to have the log. The log can be obtained this way:
+
+1. start broot with `BROOT_LOG=debug br`
+2. do the action which seems not to properly work, and nothing else
+3. quit broot
+4. go to the chat (or the GitHub issue if you already made one) and paste the content of the `dev.log` file
+
## Contribute
**Broot** is written in [rust](https://www.rust-lang.org/). The current focus is linux+mac but we try to support windows too (use PowerShell instead of the old cmd).
diff --git a/website/docs/documentation/configuration.md b/website/docs/documentation/configuration.md
index 6b01b5c..e665b25 100644
--- a/website/docs/documentation/configuration.md
+++ b/website/docs/documentation/configuration.md
@@ -216,6 +216,8 @@ invocation | default key | default shortcut | behavior / details
:toggle_dates | - | - | toggle display of last modified dates
:toggle_files | - | - | toggle showing files (or just folders)
:toggle_git_ignore | - | - | toggle git hignore handling (auto, no or yes)
+:toggle_git_file_info | - | - | toggle display of git file information
+:toggle_git_status | - | - | toggle showing only the file which would show up on `git status`
:toggle_hidden | - | - | toggle display of hidden files (the ones whose name starts with a dot on linux)
:toggle_perm | - | - | toggle display of permissions (not available on Windows)
:toggle_sizes | - | - | toggle the size mode
diff --git a/website/docs/img/20200203-git.png b/website/docs/img/20200203-git.png
new file mode 100644
index 0000000..c8ebff3
--- /dev/null
+++ b/website/docs/img/20200203-git.png
Binary files differ
diff --git a/website/docs/index.md b/website/docs/index.md
index f6a4951..88f8aa6 100644
--- a/website/docs/index.md
+++ b/website/docs/index.md
@@ -90,6 +90,9 @@ Sizes are computed in the background, you don't have to wait for them when you n
Use `:gf` to display the statuses of files (what are the new ones, the modified ones, etc.), the current branch name and the change statistics.
+And if you want to see *only* the files which would be displayed by the `git status command`, do `:gs`.
+
+
# More...
See the complete [Documentation](documentation/usage.md) and [how to install](documentation/installation.md).