From c30dee799a432cbae355878c0a35c2c70ab738b7 Mon Sep 17 00:00:00 2001 From: Travis Abendshien <46939827+CyanVoxel@users.noreply.github.com> Date: Wed, 22 Jul 2026 18:30:57 -0700 Subject: [PATCH] docs: update Nix verbage --- docs/developing.md | 2 +- docs/install.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/developing.md b/docs/developing.md index 0ad3526c..4b5252d4 100644 --- a/docs/developing.md +++ b/docs/developing.md @@ -118,7 +118,7 @@ If you choose to manually set up a virtual environment and install dependencies !!! Warning "Linux Library Dependencies" If developing TagStudio on Linux, certain libraries are required that may not be included with your distribution. A full list of these can be found [here](install.md#linux). -## Nix(OS) +## Nix & NixOS If using [Nix](https://nixos.org/), there is a development environment already provided in the [flake](https://wiki.nixos.org/wiki/Flakes) that is accessible with the following command: diff --git a/docs/install.md b/docs/install.md index 71fe804f..3abb853d 100644 --- a/docs/install.md +++ b/docs/install.md @@ -95,9 +95,9 @@ Some external dependencies are required for TagStudio to execute. Below is a tab Aborted (core dumped) ``` -### :material-nix: Nix(OS) +### :material-nix: Nix & NixOS -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. +For [Nix](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. Two packages are provided: `tagstudio` and `tagstudio-jxl`. The distinction was made because `tagstudio-jxl` has an extra compilation step for [JPEG-XL](https://jpeg.org/jpegxl) image support. To give either of them a test run, you can execute `nix run github:TagStudioDev/TagStudio#tagstudio`. If you are in a cloned repository and wish to run a package with the context of the repository, you can simply use `nix run` with no arguments. @@ -256,4 +256,4 @@ To generate thumbnails for RAR-based files (like `.cbr`) you'll need an extracto ### ripgrep -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. +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.