From a147c44df467964975615031db8c4d2acd4b1eb1 Mon Sep 17 00:00:00 2001
From: capy4king <capy4king@fsdfsd.net>
Date: Sun, 16 Jul 2023 10:31:31 +0200
Subject: [PATCH] add readme

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

diff --git a/marsey/README.md b/marsey/README.md
new file mode 100644
index 000000000..e2278dcf2
--- /dev/null
+++ b/marsey/README.md
@@ -0,0 +1,13 @@
+# Marsey font
+
+marseys/ - all marsey assets
+
+marseys/marsey_load.sh [name] - download a marsey by its name and automatically convert it to the right format and size. Must be used while inside the marsey directory.
+
+marseys.conf - links the marseys to the corresponding
+
+convert_filename.py - convert any emoji to the corresponding emoji identifier for marseys.conf. Eg, 🤓 -> emoji_u1f913.png
+
+sexrace.py - generates all gender and ethnicity variations given a placeholder input for marseys.conf. Example input for thumbs up: marseythumbsup=emoji_u1f44dRACE.png. Input for cop: marseycop=emoji_u1f46eRACEGENDERADD.png
+
+marsey_replacer.sh - replaces emojis by marseys, as specified in marseys.conf. Must be run from the marseymoji base directory.