Skip to content

Commit 21ae4d0

Browse files
committed
📝 docs: update README.md
1 parent fb4ae10 commit 21ae4d0

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -130,16 +130,18 @@ cd `your_location`
130130
</details>
131131

132132
> [!NOTE]
133-
> The [`clink-custom`](./clink/clink-custom/) directory contains Lua scripts to [extend `clink`](https://chrisant996.github.io/clink/clink.html#extending-clink) based on the programs you use.
134-
> If you don't have any of the corresponding programs, you can disable them by commenting out the files or simply remove them:
133+
> The [`clink-custom`](./clink/clink-custom/) directory contains Lua scripts to [extend `clink`](https://chrisant996.github.io/clink/clink.html#extending-clink) based on the programs you use. If you do not have the programs define in the scripts, they will not be activated.
135134
>
136-
> - `oh-my-posh` - [`clink/clink-custom/oh-my-posh.lua`](./clink/clink-custom/oh-my-posh.lua)
137-
> - `starship` - [`clink/clink-custom/starship.lua`](./clink/clink-custom/starship.lua)
138-
> - `vfox` - [`clink/clink-custom/vfox.lua`](./clink/clink-custom/vfox.lua)
139-
> - `zoxide` - [`clink/clink-custom/zoxide.lua`](./clink/clink-custom/zoxide.lua)
135+
> - custom prompt ➝ [`clink/clink-custom/prompt.lua`](./clink/clink-custom/prompt.lua).
136+
> (Only one of the following should be set to `true`, otherwise `false`)
137+
> - **`oh-my-posh`**: to <u>enable</u>, set *`local ohmyposh_enabled = true`*
138+
> - **`starship`**: to <u>enable</u>, set *`local starship_enabled = true`*
139+
> - `vfox`[`clink/clink-custom/vfox.lua`](./clink/clink-custom/vfox.lua)
140+
> - `zoxide`[`clink/clink-custom/zoxide.lua`](./clink/clink-custom/zoxide.lua)
140141
141142
<br>
142143

144+
143145
<details open>
144146
<summary><b>🌟 Bootstrap WSL</b></summary>
145147
<br>

0 commit comments

Comments
 (0)