You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/install.md
+14-2Lines changed: 14 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -50,6 +50,7 @@ TagStudio can now be launched via the `tagstudio` command in your terminal.
50
50
51
51
Some external dependencies are required for TagStudio to execute. Below is a table of known packages that will be necessary.
52
52
53
+
<!-- prettier-ignore -->
53
54
| Package | Reason |
54
55
|--------------- | --------------- |
55
56
|[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`:
97
98
98
99
Then, make sure you add the `inputs` context to your configuration:
99
100
100
-
<!-- prettier-ignore -->
101
+
<!-- prettier-ignore-start-->
101
102
=== "NixOS with Home Manager"
102
103
```nix title="flake.nix"
103
104
{
@@ -128,6 +129,9 @@ Then, make sure you add the `inputs` context to your configuration:
128
129
};
129
130
}
130
131
```
132
+
<!-- prettier-ignore-end -->
133
+
134
+
<!-- prettier-ignore-start -->
131
135
=== "NixOS"
132
136
```nix title="flake.nix"
133
137
{
@@ -167,10 +171,11 @@ Then, make sure you add the `inputs` context to your configuration:
167
171
};
168
172
}
169
173
```
174
+
<!-- prettier-ignore-end -->
170
175
171
176
Finally, `inputs` can be used in a module to add the package to your packages list:
172
177
173
-
<!-- prettier-ignore -->
178
+
<!-- prettier-ignore-start-->
174
179
=== "Home Manager module"
175
180
```nix title="home.nix"
176
181
{ inputs, pkgs, ... }:
@@ -181,6 +186,9 @@ Finally, `inputs` can be used in a module to add the package to your packages li
181
186
];
182
187
}
183
188
```
189
+
<!-- prettier-ignore-end -->
190
+
191
+
<!-- prettier-ignore-start -->
184
192
=== "NixOS module"
185
193
```nix title="configuration.nix"
186
194
{ inputs, pkgs, ... }:
@@ -191,12 +199,14 @@ Finally, `inputs` can be used in a module to add the package to your packages li
191
199
];
192
200
}
193
201
```
202
+
<!-- prettier-ignore-end -->
194
203
195
204
Don't forget to rebuild!
196
205
197
206
## Creating a Development Environment
198
207
199
208
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
+
200
210
<!-- prettier-ignore -->
201
211
!!! tip "Contributing"
202
212
If you wish to contribute to TagStudio's development, please read our [CONTRIBUTING.md](https://github.com/TagStudioDev/TagStudio/blob/main/CONTRIBUTING.md)!
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.
264
275
@@ -280,6 +291,7 @@ If you choose to manually set up a virtual environment and install dependencies
280
291
```sh
281
292
python -m venv .venv
282
293
```
294
+
283
295
2. Activate your environment:
284
296
285
297
- Windows w/Powershell: `.venv\Scripts\Activate.ps1`
0 commit comments