Skip to content

Commit

Permalink
docs: add the install method with rocks.nvim
Browse files Browse the repository at this point in the history
Fix #12
  • Loading branch information
Freed-Wu authored and black-desk committed Jun 21, 2024
1 parent 2612c6c commit 9631b78
Showing 1 changed file with 33 additions and 2 deletions.
35 changes: 33 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,38 @@ Basical fcitx5 functions seems work after a simple setup.

## Install

For packer.nvim:
### rocks.nvim

#### Command style

```vim
:Rocks install fcitx5-ui.nvim
```

#### Declare style

`~/.config/nvim/rocks.toml`:

```toml
[plugins]
"fcitx5-ui.nvim" = "scm"
```

Then

```vim
:Rocks sync
```

or:

```sh
$ luarocks --lua-version 5.1 --local --tree ~/.local/share/nvim/rocks install fcitx5-ui.nvim
# ~/.local/share/nvim/rocks is the default rocks tree path
# you can change it according to your vim.g.rocks_nvim.rocks_path
```

### packer.nvim

``` lua
require('packer').use(
Expand All @@ -20,7 +51,7 @@ require('packer').use(
)
```

For lazy.nvim:
### lazy.nvim

``` lua
return {
Expand Down

0 comments on commit 9631b78

Please sign in to comment.