Uppercase README

allusion-app · May 1, 2022 · 1beb2a5 · 1beb2a5
1 parent 66a6e37
commit 1beb2a5
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 0 deletions.
diff --git a/resources/exiftool/README.md b/resources/exiftool/README.md
@@ -0,0 +1,7 @@
+# Exiftool
+
+These files were downloaded from https://exiftool.org/index.html
+- The `win` version was renamed from `exiftool(-k).exe` to `exiftool.exe`. This one does not need the `lib` folder.
+- The `nix` version was extracted from the Perl archive (first download link), renamed from `exiftool` to `exiftool.pl`. This one requires the `lib` folder.
+
+Current version: 12.23 (April 1, 2021)
diff --git a/resources/test_images/README.md b/resources/test_images/README.md
@@ -0,0 +1,5 @@
+# Test images
+It would be nice to have automated tests for ensuring we support all image types and filenames we intend to support, but it's quite difficult to set up.
+
+For now, just add this directory as a Location in Allusion to confirm all files we want to support show up properly.
+Feel free to add more test images.
diff --git a/resources/themes/README.md b/resources/themes/README.md
@@ -0,0 +1,21 @@
+# Custom themes
+
+This folder contains a couple of theme presets, that will be copied to the user's Allusion custom themes directory when installing Allusion.
+
+## Creating a custom theme
+The default theme of Allusion can be used as a reference, which can be found in the `/resources/style/remake/themes.scss` file of Allusion's source code, which can be found [here](https://github.com/allusion-app/Allusion/blob/master/resources/style/remake/themes.scss).
+
+Feel free to share yours and try those of others through the [Github Discussions](https://github.com/allusion-app/Allusion/discussions/categories/show-and-tell)!
+
+## Loading a custom theme
+1. Open the settings panel
+2. In Appearance > Theme Customization, click the Folder button to open the "themes" folder
+3. Copy one of the preset files or create a new `.css` file with the name of your theme and customize it to your liking
+4. Click the Refresh button in the settings panel
+5. Pick the theme from the dropdown menu
+6. Enjoy!
+
+## DevTools
+The built-in Chrome Dev Tools can be used to preview colors intuitively before noting them down in a CSS file. It can be accessed through the settings panel at Advanced > Toggle DevTools or by pressing `Ctrl + Shift + I` in the main Allusion window.
+
+The theme colors are applied through the `.light` and `.dark` classes, which are set on the first HTML child element of `body > #app`.