Skip to content

Commit

Permalink
docs(readme): add screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
mrcjkb committed Oct 25, 2023
1 parent 14661bf commit e5edcd0
Showing 1 changed file with 63 additions and 3 deletions.
66 changes: 63 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,15 @@ for more configuration options.
<b>Debugging</b>
</summary>

![debugging](https://github.com/simrat39/rust-tools-demos/raw/master/rust-tools-debug.gif)
```vimscript
:RustLsp debuggables [last?]
```
```lua
vim.cmd.RustLsp {'debuggables', 'last' --[[ optional ]] }
```

![](https://github.com/mrcjkb/rustaceanvim/assets/12857160/ce17d228-ae0a-416a-8159-fe095a85dcb7)

</details>

<details>
Expand All @@ -150,6 +158,13 @@ for more configuration options.
```vimscript
:RustLsp runnables [last?]
```
```lua
vim.cmd.RustLsp {'runnables', 'last' --[[ optional ]] }
```

![](https://github.com/mrcjkb/rustaceanvim/assets/12857160/95183192-5669-4a07-804b-83f67831be57)


</details>

<details>
Expand All @@ -160,6 +175,10 @@ for more configuration options.
```vimscript
:RustLsp expandMacro
```
```lua
vim.cmd.RustLsp('expandMacro')
```
![](https://github.com/mrcjkb/rustaceanvim/assets/12857160/477d9e58-74b0-42ff-87ca-2fef34d06db3)
</details>

<details>
Expand All @@ -170,18 +189,32 @@ for more configuration options.
```vimscript
:RustLsp moveItem up
:RustLsp moveItem down
```
```
```lua
vim.cmd.RustLsp { 'moveItem', 'up' }
vim.cmd.RustLsp { 'moveItem', 'down' }
```
</details>

<details>
<summary>
<b>Hover Actions</b>
</summary>

Note: To activate hover actions, run the command twice. This will move you into the window, then press enter on the selection you want. Alternatively, you can set ```auto_focus``` to true in your config and you will automatically enter the hover actions window.
Note: To activate hover actions, run the command twice.
This will move you into the window, then press enter on the selection you want.
Alternatively, you can set `auto_focus` to `true` in your config and you will
automatically enter the hover actions window.

```vimscript
:RustLsp hover actions
```
```lua
vim.cmd.RustLsp { 'hover', 'actions' }
```

![](https://github.com/mrcjkb/rustaceanvim/assets/12857160/c7b6c730-4439-47b0-9a75-7ea4e6831f7a)

</details>

<details>
Expand All @@ -192,6 +225,9 @@ for more configuration options.
```vimscript
:RustLsp hover range
```
```lua
vim.cmd.RustLsp { 'hover', 'range' }
```
</details>

<details>
Expand All @@ -202,6 +238,9 @@ for more configuration options.
```vimscript
:RustLsp openCargo
```
```lua
vim.cmd.RustLsp('openCargo')
```
</details>

<details>
Expand All @@ -212,6 +251,9 @@ for more configuration options.
```vimscript
:RustLsp parentModule
```
```lua
vim.cmd.RustLsp('parentModule')
```
</details>

<details>
Expand All @@ -222,6 +264,9 @@ for more configuration options.
```vimscript
:RustLsp joinLines
```
```lua
vim.cmd.RustLsp('joinLines')
```
</details>

<details>
Expand All @@ -232,6 +277,9 @@ for more configuration options.
```vimscript
:RustLsp ssr [query]
```
```lua
vim.cmd.RustLsp { 'ssr', 'query' --[[ optional ]] }
```
</details>

<details>
Expand All @@ -242,6 +290,9 @@ for more configuration options.
```vimscript
:RustLsp crateGraph [backend [output]]
```
```lua
vim.cmd.RustLsp { 'crateGraph', '[backend]', '[output]' }
```
</details>

<details>
Expand All @@ -252,6 +303,12 @@ for more configuration options.
```vimscript
:RustLsp syntaxTree
```
```lua
vim.cmd.RustLsp('syntaxTree')
```

![](https://github.com/mrcjkb/rustaceanvim/assets/12857160/c865a263-1568-41c7-a32b-bc4a34b198dc)

</details>

<details>
Expand All @@ -269,6 +326,9 @@ for more configuration options.
```vimscript
:RustLsp flyCheck
```
```lua
vim.cmd.RustLsp('flyCheck')
```
</details>

<!-- markdownlint-restore -->
Expand Down

0 comments on commit e5edcd0

Please sign in to comment.