Skip to content

Commit

Permalink
docs: update README with windows error
Browse files Browse the repository at this point in the history
  • Loading branch information
vjousse committed Sep 13, 2024
1 parent 73597e8 commit 16a472a
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
- [x] **Desktop notifications** (optional)
- [x] **Built-in [themes](#-themes)**
- [x] **Custom [themes](#-themes)**
- [x] **Color gradiant** depending on the remaining time
- [x] **Tray icon** with color gradiant
- [x] **Color gradient** depending on the remaining time
- [x] **Tray icon** with color gradient
- [x] **Minimize to tray** (optional)
- [x] **Tick and end sounds** (optional)
- [x] **Multi-platform**: Linux, Mac, Windows
Expand Down Expand Up @@ -75,15 +75,17 @@ If the build is still failing try to understand why using:

NO_STRIP=true npm run tauri build -- --target x86_64-unknown-linux-gnu --verbose

You can also try to build using `docker-compose` (to maximize compatibily, normal build is failing on Archlinux for example):
You can also try to build using `docker-compose` (to maximize compatibility, normal build is failing on Archlinux for example):

docker-compose run --rm --build build-linux

Build files will be placed in the `target/` directory.

# 💀 Troubleshooting

## `Failed to create GBM buffer of size…`
## Linux

### `Failed to create GBM buffer of size…`

If you run into this error, it is likely because you're using nvidia drivers under Linux. They are several bug reports in Webkit, cf this issue for wails: https://github.com/wailsapp/wails/issues/2977#issuecomment-1791041741.

Expand All @@ -93,6 +95,12 @@ You can try to run `pomodorolm` using this command:

Thanks to @Bad3r for the [bug report](https://github.com/vjousse/pomodorolm/issues/62)!

## Windows

### App starts and then closes immediately or doesn't start at all

Check that your antivirus (Windows defender or whatever antivirus you are using) doesn't report the app as a trojan. Unfortunately, there is a known issue https://github.com/tauri-apps/tauri/issues/2486 on Tauri where a false positive is reported when executing apps generated with Tauri on Windows.

# 💯 Credits

Thanks to https://github.com/Splode/pomotroid for the original design and ideas.

0 comments on commit 16a472a

Please sign in to comment.