mirror of
https://github.com/extrawurst/gitui.git
synced 2024-11-22 02:12:58 +03:00
added faq page
This commit is contained in:
parent
02efae1499
commit
da531c61f6
@ -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))
|
||||
|
20
FAQ.md
Normal file
20
FAQ.md
Normal file
@ -0,0 +1,20 @@
|
||||
|
||||
|
||||
## <a name="table-of-contents"></a> Table of Contents
|
||||
|
||||
1. ["Bad Credentials" Error](#credentials)
|
||||
2. [Custom key bindings](#keybindings)
|
||||
|
||||
## 1. <a name="credentials"></a> "Bad Credentials" Error <small><sup>[Top ▲](#table-of-contents)</sup></small>
|
||||
|
||||
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. <a name="keybindings"></a> Custom key bindings <small><sup>[Top ▲](#table-of-contents)</sup></small>
|
||||
|
||||
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)
|
||||
|
25
README.md
25
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. <a name="features"></a> Features <small><sup>[Top ▲](#table-of-contents)</sup></small>
|
||||
|
||||
@ -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. <a name="diagnostics"></a> Diagnostics <small><sup>[Top ▲](#table-of-contents)</sup></small>
|
||||
## 8. <a name="faqs"></a> FAQs <small><sup>[Top ▲](#table-of-contents)</sup></small>
|
||||
|
||||
see [FAQs page](./FAQ.md)
|
||||
|
||||
## 9. <a name="diagnostics"></a> Diagnostics <small><sup>[Top ▲](#table-of-contents)</sup></small>
|
||||
|
||||
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. <a name="theme"></a> Color Theme <small><sup>[Top ▲](#table-of-contents)</sup></small>
|
||||
## 10. <a name="theme"></a> Color Theme <small><sup>[Top ▲](#table-of-contents)</sup></small>
|
||||
|
||||
![](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. <a name="bindings"></a> Key Bindings <small><sup>[Top ▲](#table-of-contents)</sup></small>
|
||||
## 11. <a name="bindings"></a> Key Bindings <small><sup>[Top ▲](#table-of-contents)</sup></small>
|
||||
|
||||
The key bindings can be customized: See [Key Config](KEY_CONFIG.md) on how to set them to `vim`-like bindings.
|
||||
|
||||
## 11. <a name="sponsoring"></a> Sponsoring <small><sup>[Top ▲](#table-of-contents)</sup></small>
|
||||
## 12. <a name="sponsoring"></a> Sponsoring <small><sup>[Top ▲](#table-of-contents)</sup></small>
|
||||
|
||||
[![github](https://img.shields.io/badge/-GitHub%20Sponsors-fafbfc?logo=GitHub%20Sponsors)](https://github.com/sponsors/extrawurst)
|
||||
|
||||
## 12. <a name="inspiration"></a> Inspiration <small><sup>[Top ▲](#table-of-contents)</sup></small>
|
||||
## 13. <a name="inspiration"></a> Inspiration <small><sup>[Top ▲](#table-of-contents)</sup></small>
|
||||
|
||||
- [lazygit](https://github.com/jesseduffield/lazygit)
|
||||
- [tig](https://github.com/jonas/tig)
|
||||
|
BIN
assets/bad-credentials.png
Normal file
BIN
assets/bad-credentials.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 125 KiB |
Loading…
Reference in New Issue
Block a user