chores: update docs

This commit is contained in:
Zhe Fang
2025-10-24 13:12:29 -04:00
parent 2409165b91
commit 3b4d5b9668
13 changed files with 42 additions and 39 deletions

View File

@@ -1,37 +0,0 @@
### ? Where I can find the logs?
`%LocalAppData%\Packages\37412.BetterLyrics_rd1g0rsrrtxw8\LocalCache\logs`
### ? Where I can find the lyrics cache?
`%LocalAppData%\Packages\37412.BetterLyrics_rd1g0rsrrtxw8\LocalCache\lyrics`
### ? How to install ".msixbundle" package? (for test package only)
[See this doc](https://github.com/jayfunc/BetterLyrics/blob/dev/How2Install/How2Install.md)
### ? Lyrics are moving back and forth constantly, how to fix it?
![](Snipaste_2025-08-22_14-59-53.png)
Go to Settings > Playback sources > Disable "Lyrics timeline sync" or increase "Lyrics timeline sync threshold"
### ? Wrong lyrics are shown, how to fix it?
![](Snipaste_2025-08-22_14-47-21.png)
Open search panel to manually search for the correct lyrics.
### ? Playback control panel is not showing in dock mode, how to fix it?
![](Snipaste_2025-08-22_14-50-16.png)
Hover over the bottom of the lyrics window and click on the white line to show the playback control panel.
### ? How to lock/unlock the lyrics window in desktop mode?
![](Snipaste_2025-08-22_14-52-53.png)
![](Snipaste_2025-08-22_14-53-21.png)
Alternatively, you can also use the shortcut `Ctrl+Alt+U` (default) to toggle lock/unlock.
![](Snipaste_2025-08-22_14-53-58.png)
You can change the shortcut in Settings > App appearance and behavior > Unlock and lock shortcut keys
### ? How to enable/disable immersive mode?
![](Snipaste_2025-08-22_14-58-44.png)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 151 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 148 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 157 KiB

BIN
FAQ/add-fullscreen-mode.mp4 Normal file

Binary file not shown.

BIN
FAQ/image.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 244 KiB

40
FAQ/index.md Normal file
View File

@@ -0,0 +1,40 @@
# Welcome to BetterLyrics
### Where I can find the logs?
`%LocalAppData%\Packages\37412.BetterLyrics_rd1g0rsrrtxw8\LocalCache\logs`
### Where I can find the lyrics cache?
`%LocalAppData%\Packages\37412.BetterLyrics_rd1g0rsrrtxw8\LocalCache\lyrics`
### How to add more modes?
If this is the first time that you use this app, only standard mode was initially added for you. To add more modes, follow the steps below:
Settings -> Lyrics window manager -> Create from templates -> Fullscreen mode
<video controls src="add-fullscreen-mode.mp4" title="Title"></video>
### How to switch modes
You can switch modes by pressing default shortcuts `Ctrl + Alt + S` and then choosing one of the modes displayed on your screen. (Press `Escape` to close the choosing window)
<video controls src="switch-modes.mp4" title="Title"></video>
### How to install ".msixbundle" package? (for test package only)
[See this doc](https://github.com/jayfunc/BetterLyrics/blob/dev/How2Install/How2Install.md)
### Lyrics are moving back and forth constantly, how to fix it?
![](Snipaste_2025-08-22_14-59-53.png)
Go to Settings > Playback sources > Disable "Lyrics timeline sync" or increase "Lyrics timeline sync threshold"
### Wrong lyrics are shown, how to fix it?
![](image.png)
Open search panel to manually search for the correct lyrics.
### Playback control panel is not showing in dock mode, how to fix it?
![](Snipaste_2025-08-22_14-50-16.png)
Hover over the bottom of the lyrics window and click on the white line to show the playback control panel.

BIN
FAQ/switch-modes.mp4 Normal file

Binary file not shown.

View File

@@ -1,4 +1,4 @@
[_Click here to view frequently asked questions (FAQ)_](https://github.com/jayfunc/BetterLyrics/blob/dev/FAQ/FAQ.md)
[_Click here to view frequently asked questions (FAQ)_](https://github.com/jayfunc/BetterLyrics/blob/dev/FAQ/index.md)
![](Promotion/banner.png)

View File

Before

Width:  |  Height:  |  Size: 84 KiB

After

Width:  |  Height:  |  Size: 84 KiB

View File

@@ -5,7 +5,7 @@
Be sure that you have already enable developer mode. To do that, you can follow the steps below:
1. Go to "Settings", select "System", go to "Developer Options".
![alt text](image.png)
![alt text](image-0.png)
2. Turn on "Developer Mode" and enable local PowerShell script allowance.
![alt text](image-1.png)