From f05f8de4f632132f1008151427cf760102654a28 Mon Sep 17 00:00:00 2001 From: Travis Abendshien Date: Tue, 23 Apr 2024 10:21:15 -0700 Subject: [PATCH] Update README.md - Added instructions for how to launch the shell script on Linux - Clarified macOS instructions regarding the venv --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index dbd97637..851e1f84 100644 --- a/README.md +++ b/README.md @@ -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