summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael McClintock <mrmcc3@gmail.com>2023-01-16 10:48:06 +1000
committerMichael McClintock <mrmcc3@gmail.com>2023-01-16 10:48:06 +1000
commit18ee97f37bb57fbac6b82cd8417203a611e3c3c2 (patch)
treeecc73b7be10757532d8b62710d067c72dd21a57f
parent621e32037b76c1e9e1702d94e3940f47f544a05a (diff)
downloadyo-theme-helix-18ee97f37bb57fbac6b82cd8417203a611e3c3c2.tar.gz
update README.md
-rw-r--r--README.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/README.md b/README.md
index ba78e9e..7421613 100644
--- a/README.md
+++ b/README.md
@@ -1,31 +1,31 @@
# yo-theme-helix
-A [Helix][helix] theme inspired by [Zenbones][zenbones] & [Alabaster][alabaster]. Uses [radix colors][radix].
+A [Helix][helix] theme inspired by [Zenbones][zenbones] & [Alabaster][alabaster]. Uses [Radix Colors][radix].
-## Notes
+### 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.
+- 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.
+ - Instead it takes the minimal zenbones approach 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**
+ - **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.
+with other radix color combinations without losing the principles of the theme.
[helix]: https://helix-editor.com/