X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;ds=sidebyside;f=runtime%2Fhelp%2Fhelp.md;h=94db565d42b280b0913ec3eb989a4305f998944c;hb=0cb1ad09cdcd37463765017f92d6c2a1f3d24c61;hp=fe7cb48c32065f7306f01ffdc6b4a6a50a93f34e;hpb=37d83a280f32c8ddbe74ae1e11352f9f0ec5c934;p=micro.git diff --git a/runtime/help/help.md b/runtime/help/help.md index fe7cb48c..94db565d 100644 --- a/runtime/help/help.md +++ b/runtime/help/help.md @@ -1,33 +1,60 @@ # Micro help text +Thank you for downloading and using micro. + Micro is a terminal-based text editor that aims to be easy to use and intuitive, while also taking advantage of the full capabilities of modern terminals. -*Press CtrlQ to quit, and CtrlS to save.* - If you want to see all the keybindings press CtrlE and type `help keybindings`. See the next section for more information about documentation and help. -### Accessing more help + +## Quick-start + +Press CtrlQ to quit, and CtrlS to save. Press CtrlE to start typing commands and +you can see which commands are available by pressing tab, or by viewing the help +topic `> help commands`. When I write `> ...` I mean press CtrlE and then type +whatever is there. + +Move the cursor around with the mouse or the arrow keys. Type +`> help defaultkeys` to get a quick, easy overview of the default hotkeys and +what they do. For more info on rebinding keys, see type `> help keybindings`. + +If the colorscheme doesn't look good, you can change it with +`> set colorscheme ...`. You can press tab to see the available colorschemes, or +see more information with `> help colors`. + +Press CtrlW to move between splits, and type `> vsplit filename` or +`> hsplit filename` to open a new split. + + +## Accessing more help Micro has a built-in help system much like Vim's (although less extensive). -To use it, press CtrlE to access command mode and type in `help` followed by a topic. -Typing `help` followed by nothing will open this page. +To use it, press CtrlE to access command mode and type in `help` followed by a +topic. Typing `help` followed by nothing will open this page. Here are the possible help topics that you can read: -* tutorial: A brief tutorial which gives an overview of all the other help topics -* keybindings: Gives a full list of the default keybindings as well as how to rebind them +* tutorial: A brief tutorial which gives an overview of all the other help + topics +* keybindings: Gives a full list of the default keybindings as well as how to + rebind them +* defaultkeys: Gives a more straight-forward list of the hotkey commands and what + they do. * commands: Gives a list of all the commands and what they do * options: Gives a list of all the options you can customize -* plugins: Explains how micro's plugin system works and how to create your own plugins -* colors: Explains micro's colorscheme and syntax highlighting engine and how to create your - own colorschemes or add new languages to the engine - -For example, to open the help page on plugins you would press CtrlE and type `help plugins`. - -I recommend looking at the `tutorial` help file because it is short for each section and -gives concrete examples of how to use the various configuration options in micro. However, -it does not give the in-depth documentation that the other topics provide. +* plugins: Explains how micro's plugin system works and how to create your own + plugins +* colors: Explains micro's colorscheme and syntax highlighting engine and how to + create your own colorschemes or add new languages to the engine + +For example, to open the help page on plugins you would press CtrlE and type +`help plugins`. + +I recommend looking at the `tutorial` help file because it is short for each +section and gives concrete examples of how to use the various configuration +options in micro. However, it does not give the in-depth documentation that the +other topics provide.