From 9e57ea9fb19ffdfb3f224139abd4d621b8d617cc Mon Sep 17 00:00:00 2001 From: drojf <1249449+drojf@users.noreply.github.com> Date: Thu, 25 Jan 2024 22:14:44 +1100 Subject: [PATCH] Explain how to run script in a venv --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 76adabc..38685d1 100644 --- a/README.md +++ b/README.md @@ -73,6 +73,29 @@ The `assets/files-[UNITY_VERSION]` folders contain files applied to a particular Currently these folders contain higher quality caret sprites (the little cursor/triangle displayed at the end of a text line), with the exception of the `assets/files-2019.4` folder which also contains fonts for Higurashi Rei. +### Avoiding installing python packages globally (optional) + +The `build.py` script will automatically install the packages in `requirements.txt` globally. + +If you do not wish to install globally, create virtual environment before running the program: + +``` +# Create a new virtual environment in the `venv` folder +python -m venv venv + +# Activate the venv in cmd.exe +venv\Scripts\activate.bat +# OR Activate the venv in PowerShell +venv\Scripts\Activate.ps1 + +# Now your shell should be prefixed with `(venv)` + +# Run the script +python build.py onikaushi +``` + +Make sure to activate the venv every time you want to run the script. + ### Generating .assets and .languageSpecificAssets files (Windows Only) To list the supported Higurashi chapters for this tool, run