]> git.lizzy.rs Git - micro.git/blobdiff - runtime/help/help.md
Merge pull request #283 from boombuler/autocompleteplugin
[micro.git] / runtime / help / help.md
index c2c48537b32e56a00da8395f02da95c8db7c7105..7350d6a274944754b3de6a0592be90b46d6ec249 100644 (file)
@@ -3,6 +3,12 @@
 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
 
 Micro has a built-in help system much like Vim's (although less extensive).
@@ -12,6 +18,7 @@ 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
@@ -21,15 +28,6 @@ Here are the possible help topics that you can read:
 
 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
-```
-
-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.