Skip to content

Commit

Permalink
📝 Add dependencies and install methods to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Freed-Wu committed Jul 22, 2024
1 parent fa1b899 commit 76f0118
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,3 +112,46 @@ Some Vim plugins use CLI:
- g3kb-switch
- fcitx5
- fcitx5-rime

## Dependencies

- [gobject-introspection](https://gi.readthedocs.io/): lgi needs it

```lua
require'lgi.core'.gi.require'GObject'
```

shouldn't return error.

## Install

### rocks.nvim

#### Command style

```vim
:Rocks install ime.nvim
```

#### Declare style

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

```toml
[plugins]
"ime.nvim" = "scm"
```

Then

```vim
:Rocks sync
```

or:

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

0 comments on commit 76f0118

Please sign in to comment.