search

hkupty / nvimux

Neovim as a TMUX replacement
Apache License 2.0
445 stars 17 forks source link

Not sure where to begin #23

Closed jrock2004 closed 6 years ago

jrock2004 commented 6 years ago

Trying to read the readme it's talking about a lua config file. Where do I put this? I would like to try this plugin but just not sure where to begin

Neovim version: 0.2.0

hkupty commented 6 years ago

Hi, thanks for the issue.

Lua is built into neovim starting from the version you're using, meaning that there are ways to use lua code instead of viml.

To use nvimux, you can use any plug in manager you like (I use vim-plug, https://github.com/junegunn/vim-plug).

It can be configured in either Lua our VimL. The snippet present on Readme is an example of how to configure nvimux using Lua.

The Lua configuration is enclosed between lua << EOF and EOF.

There are other ways to do that, but personally I think this is the easiest.

Please, don't refrain from writing if you still have any questions.

Cheers, Henry

jrock2004 commented 6 years ago

I am using vimplug. So in my init file I just put that lua section?

hkupty commented 6 years ago

Nvimux comes with reasonable defaults.

If you just install it with vim-plug, you'll already have <C-b>.. mappings for handling panes and navigation.

The Lua configuration is needed if you want to change any configuration option.

jrock2004 commented 6 years ago

Where can I get list of key mapping’s?

hkupty commented 6 years ago

I'm planning to make a command that shows all the maps, but for now, you can :map <C-b> (with one argument only) and it'll show everything that's mapped by Nvimux

hkupty commented 6 years ago

I'm closing this issue. Feel free to reopen this one or open a new one if you still have any issues.

Cheers, Henry

bradparks commented 5 years ago

hey! i use tmux every day, and vim every day, but would like to consider using this as a replacement, if I was sure how it worked ;-)

I use neovim, but only in the sense that I replaced my vim binary with it. All has seemed well in that regard, but I'm just not 100% sure how to use this... I've managed to get neovim to start, using the lua code you suggest in the readme, but when i press 'ctrl+a+n', I don't get, a new "window".

I think you need to assume that people coming to this may know nothing about vim itself - they only want a tmux replacment. Write the docs for that, as if they've never heard of neovim, and you'll get more adoption.

Maybe record a video of you using it, or setting it up from scratch, and put it on youtube, and I think that would help a ton. Much appreciated (and great idea!)