summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..24005b3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# sts2stats
+
+this project requires go 1.23
+
+if you have it, build the package (`pik build` or `bash .pik/build.sh`)
+
+sts2stats needs to be executed in your profile folder:
+* `cp ./sts2stats /home/$USER/.local/share/SlayTheSpire2/steam/$STEAMID/profile1/`
+ * substitute your own variables! i don't know your steam id
+* `./sts2stats`
+
+a browser window with the duckdb ui should open.