summaryrefslogtreecommitdiff
path: root/fedora/.config/yazi/flavors/scripts/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'fedora/.config/yazi/flavors/scripts/README.md')
-rw-r--r--fedora/.config/yazi/flavors/scripts/README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/fedora/.config/yazi/flavors/scripts/README.md b/fedora/.config/yazi/flavors/scripts/README.md
new file mode 100644
index 0000000..17a1ffe
--- /dev/null
+++ b/fedora/.config/yazi/flavors/scripts/README.md
@@ -0,0 +1,36 @@
+<div align="center">
+ <img src="https://github.com/sxyazi/yazi/blob/main/assets/logo.png?raw=true" alt="Yazi logo" width="20%">
+</div>
+
+<h3 align="center">
+ ${variant_cap} Flavor for <a href="https://github.com/sxyazi/yazi">Yazi</a>
+</h3>
+
+## 👀 Preview
+
+<img src="preview.png" width="600" />
+
+## 🎨 Installation
+
+```sh
+ya pkg add yazi-rs/flavors:${variant}
+```
+
+## ⚙️ Usage
+
+Set the content of your `theme.toml` to enable it as your _${mode}_ flavor:
+
+```toml
+[flavor]
+${mode} = "${variant}"
+```
+
+Make sure your `theme.toml` doesn't contain anything other than `[flavor]`, unless you want to override certain styles of this flavor.
+
+See the [Yazi flavor documentation](https://yazi-rs.github.io/docs/flavors/overview) for more details.
+
+## 📜 License
+
+The flavor is MIT-licensed, and the included tmTheme is also MIT-licensed.
+
+Check the [LICENSE](LICENSE) and [LICENSE-tmtheme](LICENSE-tmtheme) file for more details.