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

Update README.md

Browse Source 
- Added instructions for how to launch the shell script on Linux
- Clarified macOS instructions regarding the venv
This commit is contained in:
Travis Abendshien
2024-04-23 10:21:15 -07:00
parent 6c5f0c2151
commit f05f8de4f6
1 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -61,6 +61,8 @@ TagStudio is a photo & file organization application with an underlying system t
### Creating the Virtual Environment
*Skip this step if launching from the .sh script on Linux.*
1. In the root repository directory, create a python virtual environment:
`python3 -m venv .venv`
2. Activate your environment:
@@ -90,12 +92,16 @@ To launch TagStudio, launch the `start_win.bat` file. You can modify this .bat f
Alternatively, with the virtual environment loaded, run the python file at `tagstudio\tagstudio.py` from your terminal. If you're in the project's root directory, simply run `python3 tagstudio/tagstudio.py`.
#### Linux & macOS
> [!CAUTION]
> TagStudio on Linux & macOS likely won't function correctly at this time. If you're trying to run this in order to help test, debug, and improve compatibility, then charge on ahead!
With the virtual environment loaded, run the python file at "tagstudio/tagstudio.py" from your terminal. If you're in the project's root directory, simply run `python3 tagstudio/tagstudio.py`.
#### macOS
With the virtual environment loaded, run the python file at "tagstudio/tagstudio.py" from your terminal. If you're in the project's root directory, simply run `python3 tagstudio/tagstudio.py`. When launching the program in the future, remember to activate the virtual environment each time before launching *(an easier method is currently being worked on).*
#### Linux
Run the "TagStudio.sh" script, and the program should launch! (Make sure that the script is marked as executable). Note that launching from the script from outside of a terminal will not launch a terminal window with any debug or crash information. If you wish to see this information, just launch the shell script directly from your terminal with `sh TagStudio.sh`.
## Usage