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/develop.md
+14-6Lines changed: 14 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ If you wish to develop for TagStudio, you'll need to create a development enviro
6
6
!!! tip "Contributing"
7
7
If you wish to contribute to TagStudio's development, please read our [CONTRIBUTING.md](https://github.com/TagStudioDev/TagStudio/blob/main/CONTRIBUTING.md)!
8
8
9
-
## Install Python
9
+
## Installing Python
10
10
11
11
Python [3.12](https://www.python.org/downloads) is required to develop for TagStudio. Any version matching "Python 3.12.x" should work, with "x" being any number. Alternatively you can use a tool such as [pyenv](https://github.com/pyenv/pyenv) to install this version of Python without affecting any existing Python installations on your system. Tools such as [uv](#installing-with-uv) can also install Python versions.
12
12
@@ -22,7 +22,7 @@ python --version
22
22
23
23
---
24
24
25
-
####Installing with pyenv
25
+
### Installing with pyenv
26
26
27
27
If you choose to install Python using pyenv, please refer to the following instructions:
28
28
@@ -32,11 +32,19 @@ If you choose to install Python using pyenv, please refer to the following instr
32
32
33
33
---
34
34
35
-
### Installing Dependencies
35
+
## Cloning from GitHub
36
+
37
+
The repository can be cloned/downloaded via `git` in your terminal, or by downloading the zip file from the "Code" button on the [repository page](https://github.com/TagStudioDev/TagStudio).
To install the required dependencies, you can use a dependency manager such as [uv](https://docs.astral.sh/uv) or [Poetry 2.0](https://python-poetry.org). Alternatively you can create a virtual environment and manually install the dependencies yourself.
38
46
39
-
####Installing with uv
47
+
### Installing with uv
40
48
41
49
If using [uv](https://docs.astral.sh/uv), you can install the dependencies for TagStudio with the following command:
42
50
@@ -48,7 +56,7 @@ A reference `.envrc` is provided for use with [direnv](#direnv), see [`contrib/.
48
56
49
57
---
50
58
51
-
####Installing with Poetry
59
+
### Installing with Poetry
52
60
53
61
If using [Poetry](https://python-poetry.org), you can install the dependencies for TagStudio with the following command:
54
62
@@ -58,7 +66,7 @@ poetry install --with dev
58
66
59
67
---
60
68
61
-
####Manual Installation
69
+
### Manual Installation
62
70
63
71
If you choose to manually set up a virtual environment and install dependencies instead of using a dependency manager, please refer to the following instructions:
0 commit comments