Skip to content

Commit 9e57ea9

Browse files
committed
Explain how to run script in a venv
1 parent 33d24e3 commit 9e57ea9

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,29 @@ The `assets/files-[UNITY_VERSION]` folders contain files applied to a particular
7373

7474
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.
7575

76+
### Avoiding installing python packages globally (optional)
77+
78+
The `build.py` script will automatically install the packages in `requirements.txt` globally.
79+
80+
If you do not wish to install globally, create virtual environment before running the program:
81+
82+
```
83+
# Create a new virtual environment in the `venv` folder
84+
python -m venv venv
85+
86+
# Activate the venv in cmd.exe
87+
venv\Scripts\activate.bat
88+
# OR Activate the venv in PowerShell
89+
venv\Scripts\Activate.ps1
90+
91+
# Now your shell should be prefixed with `(venv)`
92+
93+
# Run the script
94+
python build.py onikaushi
95+
```
96+
97+
Make sure to activate the venv every time you want to run the script.
98+
7699
### Generating .assets and .languageSpecificAssets files (Windows Only)
77100

78101
To list the supported Higurashi chapters for this tool, run

0 commit comments

Comments
 (0)