summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 33 insertions, 1 deletions
diff --git a/README.md b/README.md
index 4dcd006..ba78e9e 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,34 @@
# yo-theme-helix
-A Helix theme inspired by Zenbones & Alabaster. Uses radix colors
+
+A [Helix][helix] theme inspired by [Zenbones][zenbones] & [Alabaster][alabaster]. Uses [radix colors][radix].
+
+## Notes
+
+- Ideas from alabaster.
+ - Comments should stand out.
+ - Use color sparingly. The rules should be simple.
+- Alabaster essentially skips eveything else it doesn't highlight keywords (reserved words) or types.
+ (which to be fair isn't really an issue for clojure)
+ - Yo doesn't go quite as far on this point.
+ - Instead it takes the minimal approach used by zenbones to highlight the remaining code constructs.
+ - subtle colors, contrast & font variants
+ - vibrant colors are left for diagnostics.
+- The default yo themes use the following:
+ - **Green: for strings (same as alabaster)**
+ - **Purple: for constant (same as alabaster)**
+ - **Blue: for comments (incl. LSP info/hints)**
+ - **Red/Amber: LSP error/warnings**
+ - **Gray/Bronze: Everything else zenbones style**
+- I'm not a designer and don't like my chances of making something look good by tweaking colors so instead
+i'll let the pros handle it.
+ - [Radix Colors][radix] are very well deisgned. with clear instructions for how to apply them.
+ - Designed for **automatic light/dark mode**.
+- Variants.
+ - It should be straightforward to use helix theme inheritance to swap out the default color palette
+with other radix color combinations without losing the design principles of the theme.
+
+
+[helix]: https://helix-editor.com/
+[zenbones]: https://github.com/mcchrish/zenbones.nvim
+[alabaster]: https://github.com/tonsky/vscode-theme-alabaster
+[radix]: https://www.radix-ui.com/colors