some additions to the plugin API

[micro.git] / runtime / help / help.md

diff --git a/runtime/help/help.md b/runtime/help/help.md
index c2c48537b32e56a00da8395f02da95c8db7c7105..22792ee71c219fc6f45c207ae3b6e5c4040774ca 100644 (file)
--- a/runtime/help/help.md
+++ b/runtime/help/help.md
@@ -3,15 +3,36 @@
 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.
 
+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.
+
+### 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.
+
+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
 * commands: Gives a list of all the commands and what they do
 * options: Gives a list of all the options you can customize
@@ -19,17 +40,8 @@ Here are the possible help topics that you can read:
 * 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`.
-
-### Usage
-
-Once you have built the editor, simply start it by running 
-`micro path/to/file.txt` or simply `micro` to open an empty buffer.
-
-Micro also supports creating buffers from stdin:
-
-```
-$ ifconfig | micro
-```
+For example, to open the help page on plugins you would press CtrlE and type `help plugins`.
 
-You can move the cursor around with the arrow keys and mouse.
+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.