Skip to content

Commit 6ae67d0

Browse files
committed
docs: add build section
1 parent 122c60d commit 6ae67d0

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
@@ -341,6 +341,22 @@ The entry point for TagStudio is `src/tagstudio/main.py`. You can target this fi
341341
}
342342
```
343343

344+
## Building
345+
346+
To build your own executables of TagStudio, first follow the steps in "[Installing with PIP](#installing-with-pip)" including the developer dependencies step. Once that's complete, run the following PyInstaller command:
347+
348+
```
349+
pyinstaller tagstudio.spec
350+
```
351+
352+
If you're on Windows or Linux and wish to build a portable executable, then pass the following flag:
353+
354+
```
355+
pyinstaller tagstudio.spec -- --portable
356+
```
357+
358+
The resulting executable file(s) will be located in a new folder named "dist".
359+
344360
## Third-Party Dependencies
345361

346362
For audio/video thumbnails and playback you'll also need [FFmpeg](https://ffmpeg.org/download.html) installed on your system. If you encounter any issues with this, please reference our [FFmpeg Help](./help/ffmpeg.md) guide.

0 commit comments

Comments
 (0)