Skip to content

Commit

Permalink
docs: Add brief troubleshooting section to docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
g026r committed Oct 13, 2024
1 parent 688b811 commit 6012be2
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion docs/userguide.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,25 @@ General keys:
* Go back a screen: `esc`
* Force-quit without saving: `ctrl+C`

### Troubleshooting

Though the chances this application wrecks your library are low, it is doing something Analogue did not intend for users
to do & as such is provided with no warranties.

Though the application creates backups of any files it modifies by default, it is still recommended that you create a
manual backup of the files in your `System/Played Games` and `System/Library/Images` directories before using.

#### Problems with Your Pocket After Using

If problems occur, first power down your Pocket. Then replace any modified files on the SD card (list.bin,
playtimes.bin, *_thumbs.bin) with the last known good backups.

If you no longer have backups, the only solution is to delete the files & start with a fresh library.

#### Problems with the Application

Please consider [opening an issue.](https://github.com/g026r/pocket-library-toolkit/issues)

### Main Menu

![main.png](images/main.png)
Expand Down Expand Up @@ -142,4 +161,4 @@ If blank, this value will be set to the current date & time.
The total time the game has been played. Contains 3 parts: an hour section, indicated by `h`, a minute section (`m`),
and a seconds section (`s`). Any of these sections are optional.

If left blank, the total time played will be set to 0.
If left blank, the total time played will be set to 0.

0 comments on commit 6012be2

Please sign in to comment.