From 3c1a6a82aeaa5d52e488c12cdb6e24cf03b36433 Mon Sep 17 00:00:00 2001 From: Yingjie Wang Date: Thu, 25 Jul 2024 00:14:26 -0400 Subject: [PATCH] init: edit readme --- README.md | 44 +------------------------------------------- 1 file changed, 1 insertion(+), 43 deletions(-) diff --git a/README.md b/README.md index 3ba41d0..37a3988 100644 --- a/README.md +++ b/README.md @@ -3,48 +3,6 @@

- Example Flavor for Yazi + My Flavor forYazi

-## 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.