Skip to content

Commit 1b4a6a8

Browse files
committed
update docs
1 parent aff1541 commit 1b4a6a8

1 file changed

Lines changed: 39 additions & 59 deletions

File tree

README.md

Lines changed: 39 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Since Neovim is a terminal based application it has to be run through something,
3131

3232
#### Supported Terminals
3333

34-
These are the terminal supported by default (when you just switch the launcher type to "terminal")
34+
These are the terminal supported by default
3535

3636
- [alacritty](https://alacritty.org/)
3737
- [foot](https://codeberg.org/dnkl/foot)
@@ -40,25 +40,53 @@ These are the terminal supported by default (when you just switch the launcher t
4040
- [st](https://st.suckless.org/)
4141
- [wezterm](https://wezterm.org/)
4242

43-
You can use any other terminal by changing the launcher options to the following:
43+
One of these (in the order presented here) will be picked depending on what you have installed.
44+
45+
If you want to pick a specific one you have to do so like this:
4446

4547
```lua
46-
-- ...
48+
{
49+
"atomicptr/defold.nvim",
50+
-- redacted for brevity...
51+
opts = {
52+
-- lets use kitty
53+
launcher = {
54+
type = "terminal",
55+
executable = "kitty",
56+
},
57+
},
58+
}
59+
```
4760

48-
launcher = {
49-
type = "terminal",
61+
#### Custom terminal
5062

51-
executable = "/usr/bin/my-custom-terminal",
63+
In order to use a custom terminal you have to configure the `launcher` section of the settings:
5264

53-
terminal = {
54-
class_argument = "--app-id=",
55-
run_argument = "-e",
65+
```lua
66+
{
67+
"atomicptr/defold.nvim",
68+
-- ...
69+
opts = {
70+
-- this time we'll add `wezterm` via absolute path
71+
launcher = {
72+
type = "terminal",
73+
executable = "/run/current-system/sw/bin/wezterm",
74+
arguments = { "start", "--class={CLASSNAME}", "--", "{NVIM}" },
5675
},
5776
},
58-
59-
-- ...
77+
}
6078
```
6179

80+
Consider adding support for the custom terminal to [`crates/bridge/src/terminals.rs`](./crates/bridge/src/terminals.rs).
81+
82+
#### Variables
83+
84+
defold.nvim is replacing these variables in the arguments list
85+
86+
- **{CLASSNAME}** - (Linux only) The class name we'll use for the terminal window
87+
- **{ADDR}** - The address (netsock) or path to the socket (fsock)
88+
- **{NVIM}** - Path to the Neovim executable
89+
6290
## Install
6391

6492
### Lazy.nvim
@@ -155,54 +183,6 @@ local defold = require "defold"
155183
defold.setup(config)
156184
```
157185

158-
### Terminal
159-
160-
If you only have one of the supported terminals installed you don't really have to do anything as defold.nvim will use the
161-
first one it finds, however assuming you want to use a specific one you gotta specify which one like this:
162-
163-
```lua
164-
{
165-
"atomicptr/defold.nvim",
166-
-- redacted for brevity...
167-
opts = {
168-
-- lets use kitty
169-
launcher = {
170-
type = "terminal",
171-
executable = "kitty",
172-
},
173-
},
174-
}
175-
```
176-
177-
### Custom terminal
178-
179-
In order to use a custom terminal you have to configure the `launcher` section of the settings:
180-
181-
```lua
182-
{
183-
"atomicptr/defold.nvim",
184-
-- ...
185-
opts = {
186-
-- this time we'll add `wezterm` via absolute path
187-
launcher = {
188-
type = "terminal",
189-
executable = "/run/current-system/sw/bin/wezterm",
190-
arguments = { "start", "--class={CLASSNAME}", "--", "{NVIM}" },
191-
},
192-
},
193-
}
194-
```
195-
196-
Consider adding support for the custom terminal to [`crates/bridge/src/terminals.rs`](./crates/bridge/src/terminals.rs).
197-
198-
### Variables
199-
200-
defold.nvim is replacing these variables in the arguments list
201-
202-
- **{CLASSNAME}** - (Linux only) The class name we'll use for the terminal window
203-
- **{ADDR}** - The address (netsock) or path to the socket (fsock)
204-
- **{NVIM}** - Path to the Neovim executable
205-
206186
## Setup
207187

208188
### Setup Neovim

0 commit comments

Comments
 (0)