X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=runtime%2Fhelp%2Ftutorial.md;h=f720a4c9d2ce3bcef820371366bf307c2f839e11;hb=3c85d31c15b060bbfda5f9c73e38117da5bfe140;hp=538d1e6fc946ce80d48e44364a3caf43f46b4d2b;hpb=2761f575657429b35b326f814c1b37823511f8d0;p=micro.git diff --git a/runtime/help/tutorial.md b/runtime/help/tutorial.md index 538d1e6f..f720a4c9 100644 --- a/runtime/help/tutorial.md +++ b/runtime/help/tutorial.md @@ -1,11 +1,22 @@ # Tutorial -This is a brief intro to micro's configuration system that will will give some -simple examples showing how to configure settings, rebind keys, +This is a brief intro to micro's configuration system that will give some +simple examples showing how to configure settings, rebind keys, and use `init.lua` to configure micro to your liking. Hopefully you'll find this useful. +### Plugins + +Micro has a plugin manager which can automatically download plugins for you. +To see the plugins 'official' plugins, go to github.com/micro-editor/plugin-channel. + +For example, if you'd like to install the snippets plugin (listed in that repo), +just press `CtrlE` to execute a command, and type `plugin install snippets`. + +For more information about the plugin manager, see the end of the `plugins` help +topic. + ### Settings In micro, your settings are stored in `~/.config/micro/settings.json`, a file @@ -68,7 +79,7 @@ what actions are available, see the `keybindings` help topic (`> help keybinding If you need more power than the json files provide, you can use the `init.lua` file. Create it in `~/.config/micro`. This file is a lua file that is run -when micro starts and is essential a one-file plugin. +when micro starts and is essentially a one-file plugin. I'll show you how to use the `init.lua` file by giving an example of how to create a binding to `CtrlR` which will execute `go run` on the current file, @@ -80,7 +91,7 @@ You can do that by putting the following in `init.lua`: function gorun() local buf = CurView().Buf -- The current buffer if buf:FileType() == "go" then - HandleShellCommand("go run " .. buf.Path, true) -- true means don't run it in the background + HandleShellCommand("go run " .. buf.Path, true, true) -- the first true means don't run it in the background end end