commit 5111f2555c383077733deed37f7d1d2a4ce844bc Author: sxyazi Date: Wed Mar 27 18:58:17 2024 +0800 first commit diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e69de29 diff --git a/LICENSE-tmtheme b/LICENSE-tmtheme new file mode 100644 index 0000000..e69de29 diff --git a/README.md b/README.md new file mode 100644 index 0000000..3ba41d0 --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +
+ Yazi logo +
+ +

+ Example Flavor for Yazi +

+ +## Cooking up a new flavor + +> [!NOTE] +> Please remove this section from your README before publishing. + +1. [x] Fork this repository and rename it to `your-flavor-name.yazi`. +2. [ ] Copy the **parts you need to customize** from the [default theme.toml](https://github.com/sxyazi/yazi/blob/main/yazi-config/preset/theme.toml) as `./flavor.toml`, and change them to meet your preferences. +3. [ ] Find a `.tmTheme` file on GitHub that matches the color of your flavor, copy it and it's license file as `./tmtheme.xml`, and `LICENSE-tmtheme`. +4. [ ] Modify the content and preview image in the README to fit your flavor. + +## 👀 Preview + + + +## 🎨 Installation + + + +```bash +# Linux/macOS +git clone https://github.com/username/example.yazi.git ~/.config/yazi/flavors/example.yazi + +# Windows +git clone https://github.com/username/example.yazi.git %AppData%\yazi\config\flavors\example.yazi +``` + +## ⚙️ Usage + +Add the these lines to your `theme.toml` configuration file to use it: + + + +```toml +[flavor] +use = "example" +``` + +## 📜 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. diff --git a/flavor.toml b/flavor.toml new file mode 100644 index 0000000..e69de29 diff --git a/preview.png b/preview.png new file mode 100644 index 0000000..a684ec8 Binary files /dev/null and b/preview.png differ diff --git a/tmtheme.xml b/tmtheme.xml new file mode 100644 index 0000000..e69de29