From fc81c43af1cd53e230ce6c9d2a9177406b6aae7a Mon Sep 17 00:00:00 2001 From: Travis Abendshien <46939827+CyanVoxel@users.noreply.github.com> Date: Sat, 11 Jan 2025 07:00:13 -0800 Subject: [PATCH] docs: add a linux install notice (#695) * docs: add a linux install notice (#689) * docs: add a linux install notice to readme (#690) --------- Co-authored-by: Qronikarz <84787215+Qronikarz@users.noreply.github.com> --- README.md | 3 +++ docs/install.md | 5 ++++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ffb3cae4..17eb5c90 100644 --- a/README.md +++ b/README.md @@ -109,6 +109,9 @@ To download TagStudio, visit the [Releases](https://github.com/TagStudioDev/TagS > [!IMPORTANT] > On macOS, you may be met with a message saying _""TagStudio" can't be opened because Apple cannot check it for malicious software."_ If you encounter this, then you'll need to go to the "Settings" app, navigate to "Privacy & Security", and scroll down to a section that says _""TagStudio" was blocked from use because it is not from an identified developer."_ Click the "Open Anyway" button to allow TagStudio to run. You should only have to do this once after downloading the application. +> [!IMPORTANT] +> On Linux with non-Qt based Desktop Environments you may be unable to open TagStudio. You need to make sure that "xcb-cursor0" or "libxcb-cursor0" packages are installed. For more info check [Missing linux dependencies](https://github.com/TagStudioDev/TagStudio/discussions/182#discussioncomment-9452896) + ### Third-Party Dependencies - For video thumbnails and playback, you'll also need [FFmpeg](https://ffmpeg.org/download.html) installed on your system. diff --git a/docs/install.md b/docs/install.md index 19edba2d..d91d25b6 100644 --- a/docs/install.md +++ b/docs/install.md @@ -7,6 +7,9 @@ For video thumbnails and playback, you'll also need [FFmpeg](https://ffmpeg.org/ !!! info "For macOS Users" On macOS, you may be met with a message saying _""TagStudio" can't be opened because Apple cannot check it for malicious software."_ If you encounter this, then you'll need to go to the "Settings" app, navigate to "Privacy & Security", and scroll down to a section that says _""TagStudio" was blocked from use because it is not from an identified developer."_ Click the "Open Anyway" button to allow TagStudio to run. You should only have to do this once after downloading the application. +!!! info "For Linux Users" + On Linux with non-Qt based Desktop Environments you may be unable to open TagStudio. You need to make sure that "xcb-cursor0" or "libxcb-cursor0" packages are installed. For more info check [Missing linux dependencies](https://github.com/TagStudioDev/TagStudio/discussions/182#discussioncomment-9452896) + ## Optional Arguments Optional arguments to pass to the program: @@ -15,4 +18,4 @@ Optional arguments to pass to the program: : Path to a TagStudio Library folder to open on start. `--config-file ` / `-c ` -: Path to the TagStudio config file to load. \ No newline at end of file +: Path to the TagStudio config file to load.