From 588fd266e233f5b625b51e71861dfa5ce1fe9ed1 Mon Sep 17 00:00:00 2001 From: Vladimir Popov Date: Sat, 8 Jun 2024 13:30:59 +0400 Subject: [PATCH] Update README --- README.md | 28 ++++++++++++++++++++++++++++ Tools.md | 28 ---------------------------- 2 files changed, 28 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 11b719a..4e0b407 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ for `lualine.nvim` with additional components. ## 📒 Contents: - [📥 Installation](#installation) - [🔧 New common component options](#new-common-component-options) + - [Make a demo](#make-a-demo) - [🧩 Provided components](#provided-components) - [ex.spellcheck](#exspellcheck) - [ex.cwd](#excwd) @@ -77,6 +78,33 @@ an icon still should be shown with `disabled` color. The difference between `co `is_enabled = false` is that in the first case a component will not be rendered at all, but in the second case only the icon with `disabled_color` will be shown. +## Make a demo + +You may try every component from this repo in the separate nvim instance. To do +this run in terminal: + +```sh +make demo component= +``` + +Where the `` is the same string as should be used in the +lualine configuration. For example: `ex.cwd`. + +Also, it's possible to pass a custom component options to the demo: + +```sh +make demo component= component_opts='' +``` + +The `` should correspond to the lua table with component options. +For example: + +```sh +make demo component=ex.cwd component_opts='{ "depth": 1 }' +``` + + + ## 🧩 Provided components _Most of the components use icons from a [patched nerd font](https://www.nerdfonts.com/) by default._ diff --git a/Tools.md b/Tools.md index c7171a1..e8dea97 100644 --- a/Tools.md +++ b/Tools.md @@ -4,7 +4,6 @@ - [ExComponent](#excomponent) - [Helpful functions](#helpful-functions) - - [Make a demo](#make-a-demo) ## ExComponent @@ -205,30 +204,3 @@ Resolves a {max_length} option of a component. The result depends on {ln}. **Return:** An integer number. - -## Make a demo - -You may try every component from this repo in the separate nvim instance. To do -this run in terminal: - -```sh -make demo component= -``` - -Where the `` is the same string as should be used in the -lualine configuration. For example: `ex.cwd`. - -Also, it's possible to pass a custom component options to the demo: - -```sh -make demo component= component_opts='' -``` - -The `` should correspond to the lua table with component options. -For example: - -```sh -make demo component=ex.cwd component_opts='{ "depth": 1 }' -``` - -