diff --git a/CHANGELOG.md b/CHANGELOG.md index 49b575fb..6aeb3d58 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,6 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 * stack popups ([#846](https://github.com/extrawurst/gitui/issues/846)) * file history log [[@cruessler](https://github.com/cruessler)] ([#381](https://github.com/extrawurst/gitui/issues/381)) * termux support on andriod [[@PeroSar](https://github.com/PeroSar)] ([#1139](https://github.com/extrawurst/gitui/issues/1139)) +* new [FAQ](./FAQ.md)s page ### Fixed * opening tags list without remotes ([#1111](https://github.com/extrawurst/gitui/issues/1111)) diff --git a/FAQ.md b/FAQ.md new file mode 100644 index 00000000..d585c996 --- /dev/null +++ b/FAQ.md @@ -0,0 +1,20 @@ + + +## Table of Contents + +1. ["Bad Credentials" Error](#credentials) +2. [Custom key bindings](#keybindings) + +## 1. "Bad Credentials" Error [Top ▲](#table-of-contents) + +Some users have trouble pushing/pulling from remotes and adding their ssh-key to their ssh-agent solved the issue. The error they get is: +![](./assets/bad-credentials.png) + +See gihtub's excellent documentation for [Adding your SSH Key to the ssh-agent](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#adding-your-ssh-key-to-the-ssh-agent) + +Note that in some cases adding the line `ssh-add -K ~/.ssh/id_ed25519`(or whatever your key is called) to your bash init script is necessary too to survive restarts. + +## 2. Custom key bindings [Top ▲](#table-of-contents) + +If you want to use `vi`-style keys or customize your key bindings in any other fassion see the specific docs on that: [key config](./KEY_CONFIG.md) + diff --git a/README.md b/README.md index 7bec130c..0bf19dda 100644 --- a/README.md +++ b/README.md @@ -32,11 +32,12 @@ 5. [Limitations](#limitations) 6. [Installation](#installation) 7. [Build](#build) -8. [Diagnostics](#diagnostics) -9. [Color Theme](#theme) -10. [Key Bindings](#bindings) -11. [Sponsoring](#sponsoring) -12. [Inspiration](#inspiration) +8. [FAQs](#faqs) +9. [Diagnostics](#diagnostics) +10. [Color Theme](#theme) +11. [Key Bindings](#bindings) +12. [Sponsoring](#sponsoring) +13. [Inspiration](#inspiration) ## 1. Features [Top ▲](#table-of-contents) @@ -181,7 +182,11 @@ works if `libgit2` builded with `-DENABLE_TRACE=ON` this feature enabled by default, to disable: `cargo install --no-default-features` -## 8. Diagnostics [Top ▲](#table-of-contents) +## 8. FAQs [Top ▲](#table-of-contents) + +see [FAQs page](./FAQ.md) + +## 9. Diagnostics [Top ▲](#table-of-contents) To run with logging enabled run `gitui -l`. @@ -192,7 +197,7 @@ This will log to: - Linux: `$HOME/.cache/gitui/gitui.log` - Windows: `%LOCALAPPDATA%/gitui/gitui.log` -## 9. Color Theme [Top ▲](#table-of-contents) +## 10. Color Theme [Top ▲](#table-of-contents) ![](assets/light-theme.png) @@ -200,15 +205,15 @@ This will log to: However, you can customize everything to your liking: See [Themes](THEMES.md). -## 10. Key Bindings [Top ▲](#table-of-contents) +## 11. Key Bindings [Top ▲](#table-of-contents) The key bindings can be customized: See [Key Config](KEY_CONFIG.md) on how to set them to `vim`-like bindings. -## 11. Sponsoring [Top ▲](#table-of-contents) +## 12. Sponsoring [Top ▲](#table-of-contents) [![github](https://img.shields.io/badge/-GitHub%20Sponsors-fafbfc?logo=GitHub%20Sponsors)](https://github.com/sponsors/extrawurst) -## 12. Inspiration [Top ▲](#table-of-contents) +## 13. Inspiration [Top ▲](#table-of-contents) - [lazygit](https://github.com/jesseduffield/lazygit) - [tig](https://github.com/jonas/tig) diff --git a/assets/bad-credentials.png b/assets/bad-credentials.png new file mode 100644 index 00000000..326d848f Binary files /dev/null and b/assets/bad-credentials.png differ