1
- ** :exclamation : NXWM is currently in * alpha* status, expect crashes/hangs and constant API change** \
2
- ** :exclamation : NXWM is currently being rewritten to wayland, which when merged will break everything**
3
- # NXWM 0.0.1
4
- Neovim X11 Window Manager allows you to use x11 windows as if they were buffers.
1
+ :exclamation : NXWM is currently being rewritten to ** wayland** , which when merged will change most things
2
+ # NXWM
3
+ ** N** eovim ** X** 11 ** W** indow ** M** anager allows you to use x11 windows as if they were buffers.
5
4
When entering a x-window-buffer, you'll need to start insert-mode to focus the x-window (unless some configurations are set to do this automatically).
6
5
## Requirements
7
6
+ ` libx11 `
@@ -12,18 +11,16 @@ When entering a x-window-buffer, you'll need to start insert-mode to focus the x
12
11
+ NOTE: some terminals may support ` TIOCGWINSZ ` while still not working (like ` neovim-qt ` )
13
12
## Installation
14
13
Use whichever package manager you like.\
15
- It is recommended to lock/pin the plugin to one version because of API changes.
14
+ It is recommended to lock/pin the plugin to one version/branch because of changes.
16
15
17
- ### you can install by
18
16
- lazy
19
17
``` lua
20
- {" altermo/nxwm" , },
18
+ {' altermo/nxwm' , branch = ' x11 ' },
21
19
```
22
20
- packer
23
21
``` lua
24
- use {" altermo/nxwm" },
22
+ use {' altermo/nxwm' , branch = ' x11 ' },
25
23
```
26
- ** :exclamation : please note that this will install version 0.0.1, as previsly setated that this is a work in progress**
27
24
28
25
## Configuration
29
26
Using ` require("nxwm").setup({}) ` is ** not required** , it is only there if you want to change the default config.
@@ -49,7 +46,7 @@ Using `require("nxwm").setup({})` is **not required**, it is only there if you w
49
46
end ,
50
47
-- Whether to be more verbose
51
48
verbal = false ,
52
- -- Map to unfocus a window
49
+ -- Map to unfocus a window (multiple key mappings is not (yet) supported)
53
50
unfocus_map = ' <A-F4>' ,
54
51
-- Create your own mappings
55
52
-- IMPORTANT: the x-window needs to be focused for such mappings to work
0 commit comments