From c9e8eadb24d1bfc3dc04312971bab51f673b02f1 Mon Sep 17 00:00:00 2001
From: Jai Sharma <jai@jai.moe>
Date: Wed, 11 Aug 2021 12:51:33 +0100
Subject: [PATCH] Update readme

---
 README.md | 40 +++++++++++++++++++++++++++++++++++++---
 1 file changed, 37 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index c78738b..0edbaa1 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,45 @@
 # hues
 
-A desktop implementation of 0x40 Hues from the [0X40 Hues project](https://0x40hues.blogspot.com/).
+## ⚠️  This project is a work in progress ⚠️
+
+A desktop implementation of 0x40 Hues from the [0x40 Hues project](https://0x40hues.blogspot.com/).
 
 Inspired by [mon's Webhues](https://0x40.mon.im/)
 
+## how to use
+
+Go to the release page for this repo and download the version for your OS.  
+Extract the file and run the `hues` executable, no need to install anything.
+
+## troubleshooting/FAQ
+
+- *Help I changed the screen mode and now it's broken!*  
+  Delete the `framework.ini` file in the base folder to reset to default
+  settings.
+
+- *How do I import a Respack?*  
+  Drag a `respack.zip` file into the window and it will be automatically
+  imported.
+
+- *Where are the imported Respacks stored?*  
+  (For now) They are not stored anywhere and only exist in-memory while the
+  program is running which means you will have to re-import them every time
+  (sorry :/).
+
+## missing features
+- Respack management
+- Remote respack loading
+- Editor
+- Hue visuals options (blur, blur decay, colours palette)
+- Program settings (fps, device management etc.)
+- Animated images
+- Image alignment
+- Beatchar effects
+  - Fade colour (`~`, `=`)
+  - Slicing (`s`, `S`, `v`, `V`, `#`, `@`)
+  - Trippy circles (`)`, `(`)
+- Clickable source links
+
 ## respack
 
 This is the specification for which this hues will interpret respack files.
@@ -101,8 +137,6 @@ An example format of a `images.xml` is as follows:
       * NOTE: Support to handle this element is currently not implemented
     * The `<image>` element may OPTIONALLY include a `<align>` element
       * NOTE: Support to handle this element is currently not implemented
-    * The `<image>` element may OPTIONALLY include a `<align>` element
-      * NOTE: Support to handle this element is currently not implemented
     * The `<image>` element may OPTIONALLY include a `<frameDuration>` element
       to indicate this image is part of an animated set
       * NOTE: Support to handle this element and animated images is currently