diff options
Diffstat (limited to 'nvim/README.md')
| m--------- | nvim | 0 | ||||
| -rw-r--r-- | nvim/README.md | 31 |
2 files changed, 31 insertions, 0 deletions
diff --git a/nvim b/nvim deleted file mode 160000 -Subproject d2e1e6a0d60cf427a8a56c0caf57c8ec60a8e36 diff --git a/nvim/README.md b/nvim/README.md new file mode 100644 index 0000000..3556609 --- /dev/null +++ b/nvim/README.md @@ -0,0 +1,31 @@ + + +# `eltrac.nvim` + +Come and observe a clumsy koala tweaks his editor. + +## Setup + +This configuration uses [Fennel](https://fennel-lang.org/) over Lua. All `.fnl` files are compiled to `.lua` (instead of evaluating during runtime) out of consideration for performance and booting speed, using [nfnl](https://github.com/Olical/nfnl). + +When installing for the first time (nfnl was not available), run this command to compile all Fennel files to Lua. Make sure you have [Babashka](https://babashka.org/) installed. + +``` shell +bb script/fennel.bb --files | bb script/fennel.bb --compile +``` + +When nfnl is available, run `:NfnlCompileAllFiles` inside Neovim to compile all, or edit a `.fnl` file to compile this file upon every `:wq`. + +## Make your own Fennel-based configuration! + +There is a [Nushell](https://www.nushell.sh/) script (`convert-to-fennel.nu`) that converts `.lua` files to `.fnl` using [antifennel](https://git.sr.ht/~technomancy/antifennel). If you have a regular Lua-based Neovim configuration, do this and you will have a working Fennel-based one! + +Be sure to back up your configuration before running these scripts: + +```shell +nu convert-to-fennel.nu +bb script/fennel.bb --files | bb script/fennel.bb --compile +``` + +If you don't use Nushell or don't have antifennel installed, this script will not work. I'll try to make time and create a self-contained binary that does this... some day. + |