aboutsummaryrefslogtreecommitdiff
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..0e7bd30
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# RMG - Random Maid Generator
+## Character description
+Character generator for the infamous Maid RPG.
+
+This is a small Python project I created when I was still in the early phase of learning programming. It is UGLY. However it works (mostly).
+
+## Backstory
+Originally it was created in Python 2 with PyQt4. Much of the sourcecode had been lost, and I could only fully recover it by decompiling an exe version I created back then with py2exe. After that I had to run a PyQt4 >> PyQt5 conversion. I'm planning to clean up the code in the future.
+
+## Necessary tools
+* Python 3
+* PyQt5