summaryrefslogtreecommitdiff
path: root/fedora/.config/yazi/flavors/tokyo-night.yazi/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'fedora/.config/yazi/flavors/tokyo-night.yazi/README.md')
-rw-r--r--fedora/.config/yazi/flavors/tokyo-night.yazi/README.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/fedora/.config/yazi/flavors/tokyo-night.yazi/README.md b/fedora/.config/yazi/flavors/tokyo-night.yazi/README.md
new file mode 100644
index 0000000..70eb613
--- /dev/null
+++ b/fedora/.config/yazi/flavors/tokyo-night.yazi/README.md
@@ -0,0 +1,47 @@
+<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">
+ Tokyo Night Flavor for <a href="https://github.com/sxyazi/yazi">Yazi</a>
+</h3>
+
+## 👀 Preview
+
+<img src="preview.png" width="600" />
+
+## 🎨 Installation
+
+### Using package manager
+
+```bash
+ya pkg add BennyOe/tokyo-night
+```
+
+### Manual install
+
+```bash
+# Linux/macOS
+git clone https://github.com/BennyOe/tokyo-night.yazi.git ~/.config/yazi/flavors/tokyo-night.yazi
+
+# Windows
+git clone https://github.com/BennyOe/tokyo-night.yazi.git %AppData%\yazi\config\flavors\tokyo-night.yazi
+```
+
+## ⚙️ Usage
+
+Add the these lines to your `theme.toml` configuration file to use it:
+
+
+```toml
+[flavor]
+use = "tokyo-night"
+# For Yazi 0.4 and above
+dark = "tokyo-night"
+```
+
+## 📜 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.