Update README

This commit is contained in:
secretspecter 2024-03-16 12:40:42 -06:00
parent b3c3cef582
commit 3333b6c6fc

View file

@ -1,31 +1,29 @@
# Scheme/Lisp Flavored NeoVim
Configuration via Fennel. Tuned for s-expressions and prose.
Configuration via [fennel](https://fennel-lang.org). Tuned for s-expressions and prose.
## Features
- **`fnl/personalize` has all the tweakable bits**
- s-expression power editing via [vim-sexp](https://github.com/guns/vim-sexp), [for regular people](https://github.com/tpope/vim-sexp-mappings-for-regular-people)
- [vim-markdown](https://github.com/preservim/vim-markdown) and [Obsidian](https://github.com/epwalsh/obsidian.nvim) powered notes.
- Fuzzy finding via [telescope](https://github.com/nvim-telescope/telescope.nvim)
- Syntax highlighting via [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter)
- Completion and snippets via [nvim-cmp](https://github.com/hrsh7th/nvim-cmp)
- Language Server Protocols via [mason](https://github.com/williamboman/mason.nvim)
## 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/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)
- [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)
- [Obsidian](https://github.com/epwalsh/obsidian.nvim) powered notes.
## Dependencies
To build some of the packages you will need:
Some of the packages/hotkeys use:
- cmake
- cargo
- npm
And some of the packages/hotkeys use:
- ripgrep
- fd
- tig
- ...
- newsboat
Inside Neovim this is useful:
```neovim
@ -33,11 +31,4 @@ Inside Neovim this is useful:
```
## 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)
- [lazy.nvim](https://github.com/folke/lazy.nvim)
- [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter)
- [mason](https://github.com/williamboman/mason.nvim)
- [telescope](https://github.com/nvim-telescope/telescope.nvim)
- [nvim-cmp](https://github.com/hrsh7th/nvim-cmp)