add docs page (#33)

Raicuparta · Oct 12, 2023 · f46de7b · f46de7b
2 parents 828db9c + 1d0ed3c
commit f46de7b
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -4,6 +4,7 @@
 > Work in progress, lots of features missing, expect bugs.
 
 This is a thing to help find games of a specific engine, and then easily install universal mods for that game. I made it because when I'm making mods for games, there's a few different steps that are repeated for every game:
+
 - Checking the game engine.
 - Checking the engine version.
 - Checking the Unity scripting backend (il2cpp/mono).

diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,16 @@
+# Rai Pal
+
+> **Warning**
+> Work in progress, lots of features missing, expect bugs.
+
+This is a thing to help find games of a specific engine, and then easily install universal mods for that game. I made it because when I'm making mods for games, there's a few different steps that are repeated for every game:
+
+- Checking the game engine.
+- Checking the engine version.
+- Checking the Unity scripting backend (il2cpp/mono).
+- Installing Unity Explorer for inspecting the game scenes.
+- etc
+
+So this tool automates a lot of that work. This also lets you filter your Steam owned games by engine, so you can for instance find all the Unreal games you own.
+
+![image](https://github.com/Raicuparta/rai-pal/assets/3955124/c8c0e8f9-e3c0-4928-9961-479cb1ef408e)