aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorPinapelz <yukais@pinapelz.com>2025-04-04 22:03:51 -0700
committerPinapelz <yukais@pinapelz.com>2025-04-04 22:03:51 -0700
commite187a7a95711d5880f66058ba8f986b01ceb8751 (patch)
tree2804fd85b966b0893972074fe994d28d14bd928d /README.md
parentc0afca9f95b78e6370b389999112f47fc7ad13e2 (diff)
readme: usage instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4582ff1..b9cc4c3 100644
--- a/README.md
+++ b/README.md
@@ -11,3 +11,20 @@ Use with caution as there may be some cases missing.
> [!CAUTION]
> If you are using Kamaitachi or using someone else's Tachi instance please check the rules to ensure that you are complying with the rules before importing your scores!!!
+
+# Usage
+All scripts are self-contained and can be run on their own after pip resolves potential dependencies. A global list of dependencies can be found in `requirements.txt`
+
+Windows (Powershell)
+```bash
+python -m venv venv
+./venv/Scripts/activate
+pip install -r requirements.txt
+```
+
+Linux
+```bash
+python -m venv venv
+source venv/bin/activate
+pip install -r requirements.txt
+```
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage