Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
.

.
  • Loading branch information
vladimir-popov committed Jun 8, 2024
1 parent 8de69fd commit 0840c9b
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 28 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ for `lualine.nvim` with additional components.
## 📒 <a name="contents:">Contents:</a>
- [📥 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)
Expand Down Expand Up @@ -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.

## 🎬 <a name="make-a-demo">Make a demo</a>

You may try every component from this repo in the separate nvim instance. To do
this run in terminal:

```sh
make demo component=<component name>
```

Where the `<component name>` 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 name> component_opts='<json object>'
```

The `<json object>` should correspond to the lua table with component options.
For example:

```sh
make demo component=ex.cwd component_opts='{ "depth": 1 }'
```

<img src="https://github.com/dokwork/lualine-ex/assets/1548114/66317d8e-6ecd-4329-bfbb-6f355c642ed6" height=100 />

## 🧩 <a name="provided-components">Provided components</a>

_Most of the components use icons from a [patched nerd font](https://www.nerdfonts.com/) by default._
Expand Down
28 changes: 0 additions & 28 deletions Tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

- [ExComponent](#excomponent)
- [Helpful functions](#helpful-functions)
- [Make a demo](#make-a-demo)

## ExComponent

Expand Down Expand Up @@ -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=<component name>
```

Where the `<component name>` 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 name> component_opts='<json object>'
```

The `<json object>` should correspond to the lua table with component options.
For example:

```sh
make demo component=ex.cwd component_opts='{ "depth": 1 }'
```

<img src="https://github.com/dokwork/lualine-ex/assets/1548114/66317d8e-6ecd-4329-bfbb-6f355c642ed6" height=100 />

0 comments on commit 0840c9b

Please sign in to comment.