calvin.erfmann/TagStudio
1
0
Fork 0
mirror of https://github.com/TagStudioDev/TagStudio.git synced 2026-01-28 22:01:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add git clone step to develop page

Browse Source
This commit is contained in:
Travis Abendshien
2025-08-06 12:42:34 -07:00
parent 424ee3bc2c
commit 809885e8b5
1 changed files with 14 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/develop.md
View File

@@ -6,7 +6,7 @@ If you wish to develop for TagStudio, you'll need to create a development enviro
!!! tip "Contributing"
If you wish to contribute to TagStudio's development, please read our [CONTRIBUTING.md](https://github.com/TagStudioDev/TagStudio/blob/main/CONTRIBUTING.md)!
## Install Python
## Installing Python
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.
@@ -22,7 +22,7 @@ python --version
---
#### Installing with pyenv
### Installing with pyenv
If you choose to install Python using pyenv, please refer to the following instructions:
@@ -32,11 +32,19 @@ If you choose to install Python using pyenv, please refer to the following instr
---
### Installing Dependencies
## Cloning from GitHub
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).
```sh
git clone https://github.com/TagStudioDev/TagStudio.git
```
## Installing Dependencies
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.
#### Installing with uv
### Installing with uv
If using [uv](https://docs.astral.sh/uv), you can install the dependencies for TagStudio with the following command:
@@ -48,7 +56,7 @@ A reference `.envrc` is provided for use with [direnv](#direnv), see [`contrib/.
---
#### Installing with Poetry
### Installing with Poetry
If using [Poetry](https://python-poetry.org), you can install the dependencies for TagStudio with the following command:
@@ -58,7 +66,7 @@ poetry install --with dev
---
#### Manual Installation
### Manual Installation
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: