Update README

This commit is contained in:
secretspecter 2024-03-09 15:15:03 -07:00
parent cd352fa327
commit 6c98956e44

View file

@ -1,41 +1,39 @@
# NeoVS (aka NeoMacs)
# Lisp Flavored NeoVim
It behaves like VSCodium but it's configured with a LISP.
Configuration via Fennel. Tuned for s-expressions and prose.
## How
- [hotpot](https://github.com/rktjmp/hotpot.nvim) is downloaded if not found via `init.lua` (to the `lazy` packages folder so it can be managed from there later)
- `fnl/init.fnl` is required from `init.lua` `fnl/init.fnl` wires up
- [`lazy.nvim`](https://github.com/folke/lazy.nvim) for package management
- `fnl/plugins.fnl` is required from `init.lua` which wires up
- [`lazy.nvim`](https://github.com/folke/lazy.nvim) for package management `:Lazy`
## Features
- Syntax highlighting via [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter)
- Language Server Protocols via [mason](https://github.com/williamboman/mason.nvim)
- Fuzzy finding via [telescope](https://github.com/nvim-telescope/telescope.nvim)
- Completion and snippets via [nvim-cmp](https://github.com/hrsh7th/nvim-cmp)
- what Inside
- this like
- [vim-markdown](https://github.com/preservim/vim-markdown)
- s-expression power editing via [nvim-sexp](https://github.com/guns/vim-sexp), [for regular people](https://github.com/tpope/vim-sexp-mappings-for-regular-people)
## Dependencies
To build some of the packages you will need:
- ctags
- cmake
- cargo
- npm
ripgrep is expected for `grep`.
And some of the packages/hotkeys use:
- ripgrep
- fd
- tig
- ...
Inside Neovim this is useful:
```neovim
:checkhealth
```
## See Also
- [fennel](https://fennel-lang.org)
- [hotpot](https://github.com/rktjmp/hotpot.nvim)
- [Neovim and Lua](https://neovim.io/doc/user/lua.html#Lua)