diff --git a/README.md b/README.md index e4a3c20..2d8c32c 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,33 @@ If you use `vim-plug`, Plug 'dccsillag/magma-nvim', { 'do': ':UpdateRemotePlugins' } ``` +If you use LazyVim, +*note: you will need to adjust the keymappings to suit yourself.* + +```lua +return { + { + "dccsillag/magma-nvim", + version = "*", + run = "UpdateRemotePlugins", + keys = { + { "mi", "MagmaInit", desc = "This command initializes a runtime for the current buffer." }, + { "mo", "MagmaEvaluateOperator", desc = "Evaluate the text given by some operator." }, + { "ml", "MagmaEvaluateLine", desc = "Evaluate the current line." }, + { "mv", "MagmaEvaluateVisual", desc = "Evaluate the selected text." }, + { "mc", "MagmaEvaluateOperator", desc = "Reevaluate the currently selected cell." }, + { "mr", "MagmaRestart!", desc = "Shuts down and restarts the current kernel." }, + { + "mx", + "MagmaInterrupt", + desc = "Interrupts the currently running cell and does nothing if not cell is running.", + }, + }, + }, +} + +``` + Note that you will still need to configure keymappings -- see [Keybindings](#keybindings). ## Suggested settings