Skip to content

Commit 2df92f2

Browse files
committed
docs: update install page
1 parent 2eb9aad commit 2df92f2

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

docs/install.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ TagStudio provides [releases](https://github.com/TagStudioDev/TagStudio/releases
1010

1111
To download executable builds of TagStudio, visit the [Releases](https://github.com/TagStudioDev/TagStudio/releases) page of the GitHub repository and download the latest release for your system under the "Assets" section at the bottom of the release.
1212

13-
TagStudio has builds for **Windows**, **macOS** _(Apple Silicon & Intel)_, and **Linux**. We also offer portable releases for Windows and Linux which are self-contained and easier to move around.
13+
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.
1414

1515
<!-- prettier-ignore -->
1616
!!! info "Third-Party Dependencies"
1717
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.
1818

1919
<!-- prettier-ignore -->
20-
!!! warning "For macOS Users"
20+
!!! warning ":fontawesome-brands-apple: macOS "Privacy & Security" Popup"
2121
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.
2222

2323
---
@@ -30,7 +30,7 @@ TagStudio has builds for **Windows**, **macOS** _(Apple Silicon & Intel)_, and *
3030

3131
Installation support will not be given to users installing from unofficial sources. Use these versions at your own risk!
3232

33-
### Installing with PIP
33+
### :fontawesome-brands-python: Installing with PIP
3434

3535
TagStudio is installable via [PIP](https://pip.pypa.io/). Note that since we don't currently distribute on PyPI, the repository needs to be cloned and installed locally. Make sure you have Python 3.12 and PIP installed if you choose to install using this method.
3636

@@ -58,7 +58,7 @@ TagStudio can now be launched via the `tagstudio` command in your terminal.
5858

5959
---
6060

61-
### Linux
61+
### :material-penguin: Linux
6262

6363
Some external dependencies are required for TagStudio to execute. Below is a table of known packages that will be necessary.
6464

@@ -79,7 +79,7 @@ Some external dependencies are required for TagStudio to execute. Below is a tab
7979
| [qt-multimedia](https://repology.org/project/qt) | required |
8080
| [qt-wayland](https://repology.org/project/qt) | Wayland support |
8181

82-
### Nix(OS)
82+
### :material-nix: Nix(OS)
8383

8484
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.
8585

@@ -213,25 +213,29 @@ Don't forget to rebuild!
213213

214214
<!-- prettier-ignore -->
215215
!!! tip
216-
You can check to see if any of these dependencies are correctly located by launching TagStudio and going to "About TagStudio" in the menu bar.
216+
You can check to see if these dependencies are correctly located by launching TagStudio and going to "About TagStudio" in the menu bar.
217217

218218
### FFmpeg/FFprobe
219219

220220
For audio/video thumbnails and playback you'll need [FFmpeg](https://ffmpeg.org/download.html) installed on your system. If you encounter any issues with this, please reference our [FFmpeg Help](./help/ffmpeg.md) guide.
221221

222-
### RAR extractor
222+
### RAR Extractor
223223

224224
To generate thumbnails for RAR-based files (like `.cbr`) you'll need an extractor capable of handling them.
225225

226-
On Linux you'll need to install either `unrar` (likely in you distro's non-free repository) or `unrar-free` from your package manager.
226+
- :material-penguin: On Linux you'll need to install either `unrar` (likely in you distro's non-free repository) or `unrar-free` from your package manager.
227227

228-
On Mac `unrar` can be installed through Homebrew's [`rar`](https://formulae.brew.sh/cask/rar) formula.
228+
- :fontawesome-brands-apple: On macOS `unrar` can be installed through Homebrew's [`rar`](https://formulae.brew.sh/cask/rar) formula.
229229

230-
On Windows you'll need to install either [`WinRAR`](https://www.rarlab.com/download.htm) or [`7-zip`](https://www.7-zip.org/) and add their folder to you `PATH`.
230+
<!-- prettier-ignore -->
231+
!!! warning ":fontawesome-brands-apple: macOS "Privacy & Security" Popup"
232+
On macOS, you may be met with a message similar to "**"unrar" Not Opened. Apple could not verify "unrar" is free of malware that may harm your Mac or compromise your privacy**" 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 "**"unrar" was blocked from use because it is not from an identified developer.**" Click the "Open Anyway" button to allow unrar to be used.
231233

232-
#### Note
234+
- :fontawesome-brands-windows: On Windows you'll need to install either [`WinRAR`](https://www.rarlab.com/download.htm) or [`7-zip`](https://www.7-zip.org/) and add their folder to you `PATH`.
233235

234-
Both `unrar` and `WinRAR` require a license, but since the evaluation copy has no time limit you can simply dismiss the prompt.
236+
<!-- prettier-ignore -->
237+
!!! tip "WinRAR License"
238+
Both `unrar` and `WinRAR` require a license, but since the evaluation copy has no time limit you can simply dismiss the prompt.
235239

236240
### ripgrep
237241

0 commit comments

Comments
 (0)