Skip to content

Commit 4397e08

Browse files
committed
docs: update install instructions
1 parent fee9480 commit 4397e08

3 files changed

Lines changed: 24 additions & 27 deletions

File tree

docs/install.md

Lines changed: 20 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
title: Installation
2+
title: Installing
33
icon: material/download
44
---
55

66
<!-- SPDX-FileCopyrightText: (c) TagStudio Contributors -->
77
<!-- SPDX-License-Identifier: GPL-3.0-only -->
88

9-
# :material-download: Installation
9+
# :material-download: Installing
1010

1111
TagStudio provides executable [releases](https://github.com/TagStudioDev/TagStudio/releases) as well as full access to its [source code](https://github.com/TagStudioDev/TagStudio) under the [GPLv3](https://github.com/TagStudioDev/TagStudio/blob/main/LICENSE) license.
1212

@@ -17,8 +17,8 @@ To download executable builds of TagStudio, visit the [Releases](https://github.
1717
TagStudio has builds for :fontawesome-brands-windows: **Windows**, :fontawesome-brands-apple: **macOS** _(Apple Silicon & Intel)_, and :material-penguin: **Linux**. We also offer portable releases for Windows and Linux which are self-contained and easier to move around.
1818

1919
<!-- prettier-ignore -->
20-
!!! info "Third-Party Dependencies"
21-
You may need to install [third-party dependencies](#third-party-dependencies) such as [FFmpeg](https://ffmpeg.org/download.html) to use the full feature set of TagStudio.
20+
!!! info "Optional Dependencies"
21+
You may need to install [optional third-party dependencies](#optional-dependencies) such as [FFmpeg](https://ffmpeg.org/download.html) to use the full feature set of TagStudio.
2222

2323
<!-- prettier-ignore -->
2424
!!! warning ":fontawesome-brands-apple: macOS "Privacy & Security" Popup"
@@ -82,6 +82,19 @@ Some external dependencies are required for TagStudio to execute. Below is a tab
8282
| [qt-multimedia](https://repology.org/project/qt) | required |
8383
| [qt-wayland](https://repology.org/project/qt) | Wayland support |
8484

85+
<!-- prettier-ignore -->
86+
!!! bug "Missing Linux Dependency Example"
87+
An error message such as the following indicates that you're missing the `libxcb-cursor` or `xcb-util-cursor` library, depending on your distro:
88+
```
89+
qt.qpa.plugin: From 6.5.0, xcb-cursor0 or libxcb-cursor0 is needed to load the Qt xcb platform plugin.
90+
qt.qpa.plugin: Could not load the Qt platform plugin "xcb" in "/tmp/_MEIayuTiW/cv2/qt/plugins" even though it was found.
91+
This application failed to start because no Qt platform plugin could be initialized. Reinstalling the application may fix this problem.
92+
93+
Available platform plugins are: vnc, wayland-egl, offscreen, wayland, linuxfb, minimalegl, eglfs, minimal, vkkhrdisplay, xcb.
94+
95+
Aborted (core dumped)
96+
```
97+
8598
### :material-nix: Nix(OS)
8699

87100
For [Nix(OS)](https://nixos.org/), the TagStudio repository includes a [flake](https://wiki.nixos.org/wiki/Flakes) that provides some outputs such as a development shell and package.
@@ -212,7 +225,9 @@ Finally, `inputs` can be used in a module to add the package to your packages li
212225

213226
Don't forget to rebuild!
214227

215-
## Third-Party Dependencies
228+
## Optional Dependencies
229+
230+
Some TagStudio functionality such as multimedia thumbnails and playback, RAR archive thumbnails, and improved directory scanning performance will require installing optional third-party dependencies. Depending on your system, you may already have one or more of these installed. To check
216231

217232
<!-- prettier-ignore -->
218233
!!! tip
@@ -242,21 +257,3 @@ To generate thumbnails for RAR-based files (like `.cbr`) you'll need an extracto
242257
### ripgrep
243258

244259
A recommended tool to improve the performance of directory scanning is [`ripgrep`](https://github.com/BurntSushi/ripgrep), a Rust-based directory walker that natively integrates with our [`.ts_ignore`](ignore.md) (`.gitignore`-style) pattern matching system for excluding files and directories. Ripgrep is already pre-installed on some Linux distributions and also available from several package managers.
245-
246-
## Common Error Messages
247-
248-
### Could not load the Qt platform plugin "xcb"
249-
250-
If you get an error message like this one:
251-
252-
```
253-
qt.qpa.plugin: From 6.5.0, xcb-cursor0 or libxcb-cursor0 is needed to load the Qt xcb platform plugin.
254-
qt.qpa.plugin: Could not load the Qt platform plugin "xcb" in "/tmp/_MEIayuTiW/cv2/qt/plugins" even though it was found.
255-
This application failed to start because no Qt platform plugin could be initialized. Reinstalling the application may fix this problem.
256-
257-
Available platform plugins are: vnc, wayland-egl, offscreen, wayland, linuxfb, minimalegl, eglfs, minimal, vkkhrdisplay, xcb.
258-
259-
Aborted (core dumped)
260-
```
261-
262-
Make sure you installed `libxcb-cursor` or `xcb-util-cursor`.

docs/preview-support.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Images will generate thumbnails the first time they are viewed or since the last
4747

4848
### :material-movie-open: Videos
4949

50-
Video thumbnails will default to the closest viable frame from the middle of the video. Both thumbnail generation and video playback in the Preview Panel requires [FFmpeg](install.md#third-party-dependencies) installed on your system.
50+
Video thumbnails will default to the closest viable frame from the middle of the video. Both thumbnail generation and video playback in the Preview Panel requires [FFmpeg](install.md#optional-dependencies) installed on your system.
5151

5252
| Filetype | Extensions | Dependencies |
5353
| --------------------- | ----------------------- | :----------: |
@@ -65,7 +65,7 @@ Video thumbnails will default to the closest viable frame from the middle of the
6565

6666
### :material-sine-wave: Audio
6767

68-
Audio thumbnails will default to embedded cover art (if any) and fallback to generated waveform thumbnails. Audio file playback is supported in the Preview Panel if you have [FFmpeg](install.md#third-party-dependencies) installed on your system. Audio waveforms are currently not cached.
68+
Audio thumbnails will default to embedded cover art (if any) and fallback to generated waveform thumbnails. Audio file playback is supported in the Preview Panel if you have [FFmpeg](install.md#optional-dependencies) installed on your system. Audio waveforms are currently not cached.
6969

7070
| Filetype | Extensions | Dependencies |
7171
| ------------------- | ------------------------ | :----------: |

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,16 +32,16 @@ extra:
3232
nav:
3333
- Home:
3434
- index.md
35-
- Getting Started:
35+
- Installing:
3636
- install.md
37-
- usage.md
3837
- Developers:
3938
- developing.md
4039
- contributing.md
4140
- style.md
4241
- Help:
4342
- help/ffmpeg.md
4443
- Using TagStudio:
44+
- usage.md
4545
- libraries.md
4646
- entries.md
4747
- preview-support.md

0 commit comments

Comments
 (0)