Skip to content

Commit fc81c43

Browse files
CyanVoxelQronikarz
andauthored
docs: add a linux install notice (TagStudioDev#695)
* docs: add a linux install notice (TagStudioDev#689) * docs: add a linux install notice to readme (TagStudioDev#690) --------- Co-authored-by: Qronikarz <[email protected]>
1 parent 3cd56a8 commit fc81c43

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,9 @@ To download TagStudio, visit the [Releases](https://github.com/TagStudioDev/TagS
109109
> [!IMPORTANT]
110110
> 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.
111111
112+
> [!IMPORTANT]
113+
> 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)
114+
112115
### Third-Party Dependencies
113116

114117
- For video thumbnails and playback, you'll also need [FFmpeg](https://ffmpeg.org/download.html) installed on your system.

docs/install.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ For video thumbnails and playback, you'll also need [FFmpeg](https://ffmpeg.org/
77
!!! info "For macOS Users"
88
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.
99

10+
!!! info "For Linux Users"
11+
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)
12+
1013
## Optional Arguments
1114

1215
Optional arguments to pass to the program:
@@ -15,4 +18,4 @@ Optional arguments to pass to the program:
1518
: Path to a TagStudio Library folder to open on start.
1619

1720
`--config-file <path>` / `-c <path>`
18-
: Path to the TagStudio config file to load.
21+
: Path to the TagStudio config file to load.

0 commit comments

Comments
 (0)