Skip to content

Commit 809885e

Browse files
committed
docs: add git clone step to develop page
1 parent 424ee3b commit 809885e

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

docs/develop.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ If you wish to develop for TagStudio, you'll need to create a development enviro
66
!!! tip "Contributing"
77
If you wish to contribute to TagStudio's development, please read our [CONTRIBUTING.md](https://github.com/TagStudioDev/TagStudio/blob/main/CONTRIBUTING.md)!
88

9-
## Install Python
9+
## Installing Python
1010

1111
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.
1212

@@ -22,7 +22,7 @@ python --version
2222

2323
---
2424

25-
#### Installing with pyenv
25+
### Installing with pyenv
2626

2727
If you choose to install Python using pyenv, please refer to the following instructions:
2828

@@ -32,11 +32,19 @@ If you choose to install Python using pyenv, please refer to the following instr
3232

3333
---
3434

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).
38+
39+
```sh
40+
git clone https://github.com/TagStudioDev/TagStudio.git
41+
```
42+
43+
## Installing Dependencies
3644

3745
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.
3846

39-
#### Installing with uv
47+
### Installing with uv
4048

4149
If using [uv](https://docs.astral.sh/uv), you can install the dependencies for TagStudio with the following command:
4250

@@ -48,7 +56,7 @@ A reference `.envrc` is provided for use with [direnv](#direnv), see [`contrib/.
4856

4957
---
5058

51-
#### Installing with Poetry
59+
### Installing with Poetry
5260

5361
If using [Poetry](https://python-poetry.org), you can install the dependencies for TagStudio with the following command:
5462

@@ -58,7 +66,7 @@ poetry install --with dev
5866

5967
---
6068

61-
#### Manual Installation
69+
### Manual Installation
6270

6371
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:
6472

0 commit comments

Comments
 (0)