feat: Move Neovim/Vim specific docs to their own README

There is too many instructions specifically for the code editors
Neovim/Vim.  Having their instructions in the main project README file
can confuse and overwhelm.
This commit is contained in:
Dionisio E Alonso 2022-08-07 18:18:48 -03:00
parent 7d2b9de5b5
commit 46daa3177e
3 changed files with 78 additions and 62 deletions

View File

@ -11,15 +11,8 @@ Take into account that this project has submodules. When cloning do it as:
$ git clone --recurse-submodules --remote-submodules https://gitlab.com/baco/dotconf.git
Some Neovim/Vim specifics
-------------------------
For using Vim with coc.nvim plugin, you need to install Node+npm. One way of
doing that is:
::
$ curl -sL install-node.now.sh/lts | bash -s -- --prefix ~/.local
Updating
''''''''
Periodically update submodules with the following ``git`` command:
::
@ -33,60 +26,10 @@ git-clone flags you can fix that by running:
$ git submodule update --remote --init
Fonts with icon glyphs
''''''''''''''''''''''
Some Neovim/Vim specifics
-------------------------
Some glyphs (icons) on Neovim/Vim might appear to be missing or broken!!! You
may need to use a patched font with the `NerdFonts <https://nerdfonts.com>`_
project.
Neovim/Vim config here has some automatic code completion. Instead of using
words or letters for representing the different kind of completion items,
this config uses nice icons like popular IDEs to give some familiar look.
Easy fix
~~~~~~~~
Choose your favourite programming font (already patched) from `NerdFonts
<https://github.com/ryanoasis/nerd-fonts/releases/tag/2.2.0-RC>`_, install it
on your system and set it as your terminal profile font.
(Alternatively)
^^^^^^^^^^^^^^^
You may prefer not to have symbols at all. In that case, you have to:
1. In ``nvim/lsp_client_settings.vim`` file comment-out/delete:
* the entry line ``formatting = {format = cmp_format}``
* the 4 diagnostics lines starting with: ``sign define DiagnosticSign``
2. In ``vim/coc-settings.json`` delete the entry
``suggest.completionItemKindLabels``.
Not so easy fix: Patch your own font
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Install FontForge, for instance, on a Debian-based distro you can install this:
::
$ sudo apt install python3-fontforge
Clone `NerdFonts <https://github.com/ryanoasis/nerd-fonts.git>`_ repository and
inside that directory run the following commands (This example assumes you are
patching Iosevka font, but you can patch one of your choice):
::
./nerd-fonts$ ls -u ~/.local/share/fonts/Iosevka/v15.6.2/ttf-unhinted/iosevka-curly-slab-{regular,bold,italic,bolditalic,extended{,bold,italic,bolditalic}}.ttf |
while read file
do
fontforge -script ./font-patcher -c -out=$HOME/.local/share/fonts/"Iosevka Nerd Font"/ -ext=otf $file
done
For other uses of the ``font-patcher`` tool you can read the `official
documentation
<https://github.com/ryanoasis/nerd-fonts#option-8-patch-your-own-font>`_.
`Neovim/Vim README <nvim/README.rst>`_
.. class:: center

72
nvim/README.rst Normal file
View File

@ -0,0 +1,72 @@
Tuning up Neovim/Vim
====================
For using Vim with coc.nvim plugin, you need to install Node+npm. One way of
doing that is:
::
$ curl -sL install-node.now.sh/lts | bash -s -- --prefix ~/.local
Fonts with icon glyphs
----------------------
Some glyphs (icons) on Neovim/Vim might appear to be missing or broken!!! You
may need to use a patched font with the `NerdFonts <https://nerdfonts.com>`_
project.
Neovim/Vim config here has some automatic code completion. Instead of using
words or letters for representing the different kind of completion items,
this config uses nice icons like popular IDEs to give some familiar look.
Easy fix
''''''''
Choose your favourite programming font (already patched) from `NerdFonts
<https://github.com/ryanoasis/nerd-fonts/releases/tag/2.2.0-RC>`_, install it
on your system and set it as your terminal profile font.
(Alternatively)
~~~~~~~~~~~~~~~
You may prefer not to have symbols at all. In that case, you have to:
1. In ``nvim/lsp_client_settings.vim`` file comment-out/delete:
* the entry line ``formatting = {format = cmp_format}``
* the 4 diagnostics lines starting with: ``sign define DiagnosticSign``
2. In ``vim/coc-settings.json`` delete the entry
``suggest.completionItemKindLabels``.
Not so easy fix: Patch your own font
''''''''''''''''''''''''''''''''''''
Install FontForge, for instance, on a Debian-based distro you can install this:
::
$ sudo apt install python3-fontforge
Clone `NerdFonts <https://github.com/ryanoasis/nerd-fonts.git>`_ repository and
inside that directory run the following commands (This example assumes you are
patching Iosevka font, but you can patch one of your choice):
::
./nerd-fonts$ ls -u ~/.local/share/fonts/Iosevka/v15.6.2/ttf-unhinted/iosevka-curly-slab-{regular,bold,italic,bolditalic,extended{,bold,italic,bolditalic}}.ttf |
while read file
do
fontforge -script ./font-patcher -c -out=$HOME/.local/share/fonts/"Iosevka Nerd Font"/ -ext=otf $file
done
For other uses of the ``font-patcher`` tool you can read the `official
documentation
<https://github.com/ryanoasis/nerd-fonts#option-8-patch-your-own-font>`_.
.. class:: center
~ Made with ❤️ and 🧉 ~
.. vim: se ft=rst

1
vim/README.rst Symbolic link
View File

@ -0,0 +1 @@
../nvim/README.rst