Skip to content

Commit 94761b6

Browse files
committed
chore: format with prettier, add ignore flags
1 parent 290d1d6 commit 94761b6

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

docs/install.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ TagStudio can now be launched via the `tagstudio` command in your terminal.
5050

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

53+
<!-- prettier-ignore -->
5354
| Package | Reason |
5455
|--------------- | --------------- |
5556
| [dbus](https://repology.org/project/dbus) | required for Qt; opening desktop applications |
@@ -97,7 +98,7 @@ This can be done by first adding the flake input into your `flake.nix`:
9798

9899
Then, make sure you add the `inputs` context to your configuration:
99100

100-
<!-- prettier-ignore -->
101+
<!-- prettier-ignore-start -->
101102
=== "NixOS with Home Manager"
102103
```nix title="flake.nix"
103104
{
@@ -128,6 +129,9 @@ Then, make sure you add the `inputs` context to your configuration:
128129
};
129130
}
130131
```
132+
<!-- prettier-ignore-end -->
133+
134+
<!-- prettier-ignore-start -->
131135
=== "NixOS"
132136
```nix title="flake.nix"
133137
{
@@ -167,10 +171,11 @@ Then, make sure you add the `inputs` context to your configuration:
167171
};
168172
}
169173
```
174+
<!-- prettier-ignore-end -->
170175

171176
Finally, `inputs` can be used in a module to add the package to your packages list:
172177

173-
<!-- prettier-ignore -->
178+
<!-- prettier-ignore-start -->
174179
=== "Home Manager module"
175180
```nix title="home.nix"
176181
{ inputs, pkgs, ... }:
@@ -181,6 +186,9 @@ Finally, `inputs` can be used in a module to add the package to your packages li
181186
];
182187
}
183188
```
189+
<!-- prettier-ignore-end -->
190+
191+
<!-- prettier-ignore-start -->
184192
=== "NixOS module"
185193
```nix title="configuration.nix"
186194
{ inputs, pkgs, ... }:
@@ -191,12 +199,14 @@ Finally, `inputs` can be used in a module to add the package to your packages li
191199
];
192200
}
193201
```
202+
<!-- prettier-ignore-end -->
194203

195204
Don't forget to rebuild!
196205

197206
## Creating a Development Environment
198207

199208
If you wish to develop for TagStudio, you'll need to create a development environment by installing the required dependencies. You have a number of options depending on your level of experience and familiarly with existing Python toolchains.
209+
200210
<!-- prettier-ignore -->
201211
!!! tip "Contributing"
202212
If you wish to contribute to TagStudio's development, please read our [CONTRIBUTING.md](https://github.com/TagStudioDev/TagStudio/blob/main/CONTRIBUTING.md)!
@@ -259,6 +269,7 @@ ln -s .envrc.recommended .envrc
259269

260270
You will have to allow usage of it.
261271

272+
<!-- prettier-ignore -->
262273
!!! warning "`.envrc` Security"
263274
These files are generally a good idea to check, as they execute commands on directory load. direnv has a security framework to only run `.envrc` files you have allowed, and does keep track on if it has changed. So, with that being said, the file may need to be allowed again if modifications are made.
264275

@@ -280,6 +291,7 @@ If you choose to manually set up a virtual environment and install dependencies
280291
```sh
281292
python -m venv .venv
282293
```
294+
283295
2. Activate your environment:
284296

285297
- Windows w/Powershell: `.venv\Scripts\Activate.ps1`

0 commit comments

Comments
 (0)