From b68f2c4701cb5ad3fa4c18be42b08abc209eb49c Mon Sep 17 00:00:00 2001 From: Kyosuke Fujimoto Date: Sat, 10 Aug 2024 11:02:43 +0900 Subject: [PATCH] Update documents --- CONTRIBUTING.md | 8 ++++-- README.md | 76 ++++++++++++++++++++++++++----------------------- 2 files changed, 47 insertions(+), 37 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5900277..c56ea4e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,9 +31,13 @@ Please share your experience with other terminals on the [Discussions](https://g ## Pull Requests -When creating a pull request, please ensure you follow the same guidelines as [mentioned for issues](#reporting-issues). +We welcome pull requests, but please note that they are not guaranteed to be accepted. Following this guideline will increase the likelihood of your pull request being approved. -Creating a pull request does not necessarily require an issue. For complex problems, creating an issue beforehand might make the process smoother. +### Creating pull requests + +- When creating a pull request, please ensure you follow the same guidelines as [mentioned for issues](#reporting-issues). +- Creating a pull request does not necessarily require an issue. But if the problem is complex, creating an issue beforehand might make the process smoother. +- Do not include fixes that are not directly related to the pull request topic. ### Improving the Commit Graph diff --git a/README.md b/README.md index 3bb9be6..7ce96bf 100644 --- a/README.md +++ b/README.md @@ -127,56 +127,58 @@ If `--no-cache` is specified, this cache image will not be used or saved. You can see the keybindings by pressing the `?` key. +The default key bindings can be overridden. Please refer to [default-keybind.toml](./assets/default-keybind.toml) and add it to [config.toml](#config). +
-List of all keybindings +List of all default keybindings #### Common -| Key | Description | -| ------------------------------ | ----------- | -| Ctrl-c q | Quit app | -| ? | Open help | +| Key | Description | Corresponding keybind | +| ------------------------------ | ----------- | --------------------- | +| Ctrl-c q | Quit app | `force_quit` `quit` | +| ? | Open help | `help_toggle` | #### Commit List -| Key | Description | -| --------------------------------- | -------------------------------------------------- | -| Down/Up j/k | Move down/up | -| g/G | Go to top/bottom | -| Ctrl-f/b | Scroll page down/up | -| Ctrl-d/u | Scroll half page down/up | -| H/M/L | Select top/middle/bottom of the screen | -| Enter | Show commit details
Apply search (if searching) | -| Tab | Open refs list | -| / | Start search | -| Esc | Cancel search | -| n/N | Go to next/previous search match | -| c/C | Copy commit short/full hash | +| Key | Description | Corresponding keybind | +| --------------------------------- | -------------------------------------------------- | -------------------------------------------- | +| Down/Up j/k | Move down/up | `navigate_down` `navigate_up` | +| g/G | Go to top/bottom | `go_to_top` `go_to_bottom` | +| Ctrl-f/b | Scroll page down/up | `page_down` `page_up` | +| Ctrl-d/u | Scroll half page down/up | `half_page_down` `half_page_up` | +| H/M/L | Select top/middle/bottom of the screen | `select_top` `select_middle` `select_bottom` | +| Enter | Show commit details
Apply search (if searching) | `confirm` | +| Tab | Open refs list | `ref_list_toggle` | +| / | Start search | `search` | +| Esc | Cancel search | `close_or_cancel` | +| n/N | Go to next/previous search match | `go_to_next` `go_to_previous` | +| c/C | Copy commit short/full hash | `short_copy` `full_copy` | #### Commit Detail -| Key | Description | -| ----------------------------------- | --------------------------- | -| Esc Backspace | Close commit details | -| Down/Up j/k | Scroll down/up | -| c/C | Copy commit short/full hash | +| Key | Description | Corresponding keybind | +| ----------------------------------- | --------------------------- | ----------------------------- | +| Esc Backspace | Close commit details | `close_or_cancel` | +| Down/Up j/k | Scroll down/up | `navigate_down` `navigate_up` | +| c/C | Copy commit short/full hash | `short_copy` `full_copy` | #### Refs List -| Key | Description | -| -------------------------------------------------- | ---------------- | -| Esc Backspace Tab | Close refs list | -| Down/Up j/k | Move down/up | -| g/G | Go to top/bottom | -| Right/Left l/h | Open/Close node | -| c | Copy ref name | +| Key | Description | Corresponding keybind | +| -------------------------------------------------- | ---------------- | ----------------------------------- | +| Esc Backspace Tab | Close refs list | `close_or_cancel` `ref_list_toggle` | +| Down/Up j/k | Move down/up | `navigate_down` `navigate_up` | +| g/G | Go to top/bottom | `go_to_top` `go_to_bottom` | +| Right/Left l/h | Open/Close node | `navigate_right` `navigate_left` | +| c | Copy ref name | `short_copy` | #### Help -| Key | Description | -| ------------------------------------------------ | -------------- | -| Esc Backspace ? | Close help | -| Down/Up j/k | Scroll down/up | +| Key | Description | Corresponding keybind | +| ------------------------------------------------ | -------------- | ----------------------------- | +| Esc Backspace ? | Close help | `help_toggle` | +| Down/Up j/k | Scroll down/up | `navigate_down` `navigate_up` |
@@ -221,6 +223,10 @@ date_format = "%Y-%m-%d %H:%M:%S %z" # Whether to show a author/committer date in the commit list in local timezone. # type: boolean date_local = true + +[keybind] +# See ./assets/default-keybind.toml for a specific example configuration. +# ... ``` ## Compatibility @@ -256,8 +262,8 @@ Please share your experience with other terminal emulators on the [Discussions]( ## Contributing -Contributions are welcome. To get started with contributing, please review [CONTRIBUTING.md](CONTRIBUTING.md). + Contributions that do not follow these guidelines may not be accepted. ## Screenshots