From d08bc254b24eadbbea14399e52306dbc436f1f18 Mon Sep 17 00:00:00 2001
From: 283375 <bilibili283375@163.com>
Date: Sun, 17 Sep 2023 18:09:44 +0800
Subject: [PATCH] chore: add README

---
 README.md | 9 +++++++++
 1 file changed, 9 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a06a1da
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+# Arcaea Offline PySide UI
+
+GUI for both [283375/arcaea-offline](https://github.com/283375/arcaea-offline) and [283375/arcaea-offline-ocr](https://github.com/283375/arcaea-offline-ocr)
+
+## Before you run `python index.py`...
+
+* Install requirements
+* Release translation files from `ui/resources/lang/*.ts`
+* Compile `ui/resources/resources.qrc` to `ui/resources/resources_rc.py`