Skip to content

Commit 55d4f18

Browse files
committed
docs: add horizontal rules to install instructions
1 parent 301157d commit 55d4f18

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/install.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ TagStudio has builds for **Windows**, **macOS** _(Apple Silicon & Intel)_, and *
1212
!!! info "For macOS Users"
1313
On macOS, you may be met with a message saying "**"TagStudio" can't be opened because Apple cannot check it for malicious software.**" If you encounter this, then you'll need to go to the "Settings" app, navigate to "Privacy & Security", and scroll down to a section that says "**"TagStudio" was blocked from use because it is not from an identified developer.**" Click the "Open Anyway" button to allow TagStudio to run. You should only have to do this once after downloading the application.
1414

15+
---
16+
1517
### Package Managers
1618

1719
<!-- prettier-ignore -->
@@ -46,6 +48,8 @@ pip install .
4648

4749
TagStudio can now be launched via the `tagstudio` command in your terminal.
4850

51+
---
52+
4953
### Linux
5054

5155
Some external dependencies are required for TagStudio to execute. Below is a table of known packages that will be necessary.
@@ -197,6 +201,8 @@ Finally, `inputs` can be used in a module to add the package to your packages li
197201

198202
Don't forget to rebuild!
199203

204+
---
205+
200206
## Creating a Development Environment
201207

202208
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.
@@ -219,6 +225,8 @@ If you already have Python installed on your system, you can check the version b
219225
python --version
220226
```
221227

228+
---
229+
222230
#### Installing with pyenv
223231

224232
If you choose to install Python using pyenv, please refer to the following instructions:
@@ -227,6 +235,8 @@ If you choose to install Python using pyenv, please refer to the following instr
227235
2. Install the appropriate Python version with pyenv by running `pyenv install 3.12` (This will **not** mess with your existing Python installation).
228236
3. Navigate to the repository root folder in your terminal and run `pyenv local 3.12`. You could alternatively use `pyenv shell 3.12` or `pyenv global 3.12` instead to set the Python version for the current terminal session or the entire system respectively, however using `local` is recommended.
229237

238+
---
239+
230240
### Installing Dependencies
231241

232242
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.
@@ -239,6 +249,8 @@ If using [uv](https://docs.astral.sh/uv), you can install the dependencies for T
239249
uv pip install -e .[dev]
240250
```
241251

252+
---
253+
242254
#### Installing with Poetry
243255

244256
If using [Poetry](https://python-poetry.org), you can install the dependencies for TagStudio with the following command:
@@ -247,6 +259,8 @@ If using [Poetry](https://python-poetry.org), you can install the dependencies f
247259
poetry install --with dev
248260
```
249261

262+
---
263+
250264
#### Installing with Nix
251265

252266
If using [Nix](https://nixos.org/), there is a development environment already provided in the [flake](https://wiki.nixos.org/wiki/Flakes) that is accessible with the following command:
@@ -272,6 +286,8 @@ cat .envrc # You are checking them, right?
272286
direnv allow
273287
```
274288

289+
---
290+
275291
#### Manual Installation
276292

277293
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

Comments
 (0)