Browse Source

Documentation updates

master
Adam Pippin 2 years ago
parent
commit
4a4e4ff97a
  1. 32
      doc/nukevim.txt

32
doc/nukevim.txt

@ -140,28 +140,26 @@ important to get immediately productive.
Check out, unzip, copy or otherwise place the repo contents in your
`~/.config/nvim` folder (or whatever your platform uses).
Run `nvim +PlugInstall +NukeVimInstall +qall` to install all the relevant
plugins, perform any initial NukeVim or other plugin setup tasks, and exit.
Run `nvim +NukeVimInstall +qall` to install all the relevant plugins, perform
any initial NukeVim or other plugin setup tasks, and exit.
This may take several minutes if you have a few coc extensions. npm is sloooow.
This may take a few minutes.
--------------------------------------------------------------------------------
2.1 Dependencies *NukeVimDependencies*
Your nvim install should have the Python3 provider properly set up. Verify
this with the `:checkhealth` command. Generally this requires installing the
`pynvim` package, but the checkhealth command should point you in the right
direction.
There are providers, external programs, and several other things required in
order for all plugins and included functionality to work (or even make sense).
// TODO: Add a NukeVim checkhealth provider to just validate all this shit automatically.
If any specific functionality is missing a dependency, NukeVim _should_ continue
to function without that dependency just missing the relevant functionality. If
it does not, that's a bug.
Several plugins require external programs in order to function (in many cases
to even make sense at all). Those are listed below.
At any time you should be able to validate which plugins are enabled and, if
they are not, why they failed to function by running `:checkhealth nukevim`.
Generally you should be able to get by without any of these programs installed,
the associated plugins should just automatically be disabled. If not, that's
a bug.
For reference, the external dependencies are listed below:
*composer* -- php package manager
Required By: phpctags, vim-composer
@ -191,6 +189,9 @@ See: https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
Required By: phpctags, vim-composer
See: https://php.org/
*python3* -- neovim python3 provider (python3 + pip3 install pynvim)
Required By: vdebug
================================================================================
3. Features *NukeVimFeature*
@ -461,6 +462,7 @@ screen.
================================================================================
5. Modules *NukeVimModule*
Modules are the core of NukeVim, generally providing high-level/core
functionality. Though because of technical limitations there are a couple that
are quite specific.
@ -652,8 +654,8 @@ logic. See |NukeVimArchPlugin| for more information.
If any of a plugin's requirements are not met it will simply not be loaded. This
should allow NukeVim to simply adapt to whatever is available at the time. If
any expected functionality is missing, running `:checkhealth` should report
why a plugin wasn't loaded under the plugin module section.
any expected functionality is missing, running `:checkhealth nukevim` should
report why a plugin wasn't loaded under the plugin module section.
--------------------------------------------------------------------------------

Loading…
Cancel
Save