Skip to content

docs: improve README with how-to guides and troubleshooting section #4691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs: improve README with how-to guides and troubleshooting section #4691

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9204835
docs: improve README with FAQ clarifications and installation trouble…
Redwood-Digital Jul 6, 2025
11e34b6
fix: add Windows state path and PowerShell TERM instructions
Redwood-Digital Jul 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
fix: add Windows state path and PowerShell TERM instructions
  • Loading branch information
@Redwood-Digital
Redwood-Digital authored Jul 6, 2025
commit 11e34b60b6826f774bcd89db5e87e064d2bb6d9e
17 changes: 15 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -567,7 +567,9 @@ Common questions and their answers:
Lazygit tracks repositories you've opened and shows them when you start lazygit outside a git repo.

- Recent repos appear in the initial launch screen
- They're stored in the state file at `~/.config/lazygit/state.yml`
- They're stored in the state file at:
- Linux/Mac: `~/.local/state/lazygit/state.yml`
- Windows: `%LOCALAPPDATA%\lazygit\state.yml`
- Repos are sorted by last access time
- You can clear the list by editing the state file
</details>
Expand Down Expand Up @@ -623,7 +625,18 @@ Common questions and their answers:
3. **For Windows Terminal:**
- Usually works out of the box, but try setting `TERM=xterm` if issues persist

4. **For tmux users:**
4. **For PowerShell on Windows:**
- Set the TERM environment variable:
```powershell
$env:TERM = "xterm"
```
- To make it permanent, add to your PowerShell profile:
```powershell
# Add to $PROFILE (usually ~/Documents/PowerShell/Microsoft.PowerShell_profile.ps1)
$env:TERM = "xterm"
```

5. **For tmux users:**
```sh
# In your .tmux.conf
set -g default-terminal "screen-256color"
Expand Down
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy