From 3bed99dda6b439123ffb083b547dd84a80f18374 Mon Sep 17 00:00:00 2001
From: lukewhitfield28 <lukewhitfield28@gmail.com>
Date: Wed, 18 Sep 2024 19:41:21 +0100
Subject: [PATCH] Update README. Ensure white text on certain UI elements.

---
 README.md             | 68 ++++++++++++++++++++++++++++++++++++++++++-
 victorialyser/main.ui | 11 ++++---
 2 files changed, 72 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 4ed0dcb..5f95b4a 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,67 @@
-# victorialyser
\ No newline at end of file
+# victorialyser
+
+A portmanteau of "Victoria 2" and "Analyser".
+
+Inspired by [VickyWarAnalyzer](https://github.com/TKasekamp/VickyWarAnalyzer), this Victoria 2 save game analyser provides a modern method of reading war data from your playthroughs as you might during an AAR. Like he who inspired the project, this began as a learning opportunity but has developed into a workable project with further development planned.
+
+# Requirements
+## Python 3
+### Windows
+For the best experience, please install Python 3 through the [official website](https://www.python.org/downloads/). 
+
+Otherwise, please use the Windows Store.
+
+### Linux
+Python 3 is likely already installed. If not, install it using your preferred package manager.
+
+# Installation
+## Recommended
+### pipx
+The pipx project allows you to easily install the application in an isolated virtual environment, adding victorialyser to your $PATH for ease of use. 
+
+If pipx is not already installed on your system, please install it using the instructions found on the [official GitHub repository](https://github.com/pypa/pipx).
+
+Once installed, these commands can be used as a guide on how to install and run victorialyser:
+#### Clone victorialyser
+```bash
+git clone https://github.com/lukewhitfield28/victorialyser.git
+```
+
+#### Change directory into the cloned folder
+```bash
+cd victorialyser
+```
+
+#### Install victorialyser
+```bash
+pipx install --include-deps .
+```
+
+#### The result of the previous command may recommend you run this to add victorialyser to $PATH
+```bash
+pipx ensurepath
+```
+
+#### Finally, you can call victorialyser from your command line or terminal:
+```bash
+victorialyser
+```
+
+These are loose instructions. For example, you may have to call pipx directly by finding where the executable is installed. You can also create your own virtual environment, or run the scripts in a variety of other ways per your discretion. If you need help, please don't hesitate to ask and I'll aim to help you as soon as possible. In the future, I hope to release executable binaries to make the process easier.
+
+# Usage
+On first launch, you will first be prompted to select the folder containing your Victoria 2 installation. This folder is almost certainly called Victoria 2 and found in a directory such as "../steam/steamapps/common/Victoria 2." 
+
+Afterwards, you will be prompted to select a save game file. Any "*.v2" file is valid. 
+
+The analyser will now load, with the option to change both these settings found in the bottom-right.
+
+# Future Development
+## Mod Support
+There's currently implicit mod support. Any modded file should load, but with missing information. This will vary from missing graphics, localisation, or missing figures from unaccounted unit types. I intend to add full mod support in the future.
+
+## Statistics
+Certain data points are currently excluded, for example war goals, as they aren't collated very well in the save files. I do intend on presenting this data in the future, along with niche yet valuable information such as province terrain modifiers. This would naturally coincide with pulling data through modded files.
+
+## Suggestions
+Any and all feedback is appreciated. I will periodically update this page when appropriate.
\ No newline at end of file
diff --git a/victorialyser/main.ui b/victorialyser/main.ui
index 129c675..a1de5aa 100644
--- a/victorialyser/main.ui
+++ b/victorialyser/main.ui
@@ -37,7 +37,7 @@
         </rect>
        </property>
        <property name="styleSheet">
-        <string notr="true">background-color: transparent;</string>
+        <string notr="true">background-color: transparent;color: rgb(255, 255, 255);</string>
        </property>
       </widget>
       <widget class="QLabel" name="details_label">
@@ -77,7 +77,7 @@
         <bool>false</bool>
        </property>
        <property name="styleSheet">
-        <string notr="true">background-color: transparent;</string>
+        <string notr="true">background-color: transparent;color: rgb(255, 255, 255);</string>
        </property>
       </widget>
       <widget class="QLabel" name="tag_label">
@@ -132,7 +132,7 @@
         </rect>
        </property>
        <property name="styleSheet">
-        <string notr="true">background-color: transparent;</string>
+        <string notr="true">background-color: transparent;color: rgb(255, 255, 255);</string>
        </property>
       </widget>
       <widget class="QLabel" name="battle_label">
@@ -541,7 +541,7 @@
         <bool>false</bool>
        </property>
        <property name="styleSheet">
-        <string notr="true"/>
+        <string notr="true">color: rgb(255, 255, 255);</string>
        </property>
        <property name="text">
         <string>Load Save</string>
@@ -570,7 +570,7 @@
         <bool>false</bool>
        </property>
        <property name="styleSheet">
-        <string notr="true"/>
+        <string notr="true">color: rgb(255, 255, 255);</string>
        </property>
        <property name="text">
         <string>Load Game</string>
@@ -1192,7 +1192,6 @@
   </widget>
  </widget>
  <resources>
-  <include location="background.qrc"/>
   <include location="../../.designer/backup/background.qrc"/>
  </resources>
  <connections/>