This fixes zyedidia/micro#329

[micro.git] / README.md

diff --git a/README.md b/README.md
index b2c86b3bfede5191860478aafcacfea0633d0a7c..167bd725789e6839d2e59bc1f8dace1fa9a4693e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -40,9 +40,10 @@ To see more screenshots of micro, showcasing all of the default colorschemes, se
 * Copy and paste with the system clipboard
 * Small and simple
 * Easily configurable
+* Macros
 * Common editor things such as undo/redo, line numbers, unicode support...
 
-Although not yet implemented, I hope to add more features such as autocompletion, and multiple cursors in the future.
+Although not yet implemented, I hope to add more features such as autocompletion ([#174](https://github.com/zyedidia/micro/issues/174)), and multiple cursors ([#5](https://github.com/zyedidia/micro/issues/5)) in the future.
 
 # Installation
 
@@ -61,6 +62,15 @@ and you'll see all the stable releases with the corresponding binaries.
 
 If you'd like to see more information after installing micro, run `micro -version`.
 
+### Homebrew
+
+You can also install micro using Homebrew:
+
+```
+$ brew tap zyedidia/micro
+$ brew install micro
+```
+
 ### Building from source
 
 If your operating system does not have binary, but does run Go, you can build from source.
@@ -83,7 +93,14 @@ sudo apt-get install xclip
 
 If you don't have xclip or xsel, micro will use an internal clipboard for copy and paste, but it won't work with external applications.
 
-### Windows colors
+### Colors and syntax highlighting
+
+If you open micro and it doesn't seem like syntax highlighting is working, this is probably because
+you are using a terminal which does not support 256 color. Try changing the colorscheme to `simple`
+by running `> set colorscheme simple`.
+
+If you are using the default ubuntu terminal, to enable 256 make sure your `TERM` variable is set
+to `xterm-256color`.
 
 Many of the Windows terminals don't support more than 16 colors, which means
 that micro's default colorscheme won't look very good. You can either set
@@ -115,7 +132,14 @@ click to enable line selection.
 # Documentation and Help
 
 Micro has a built-in help system which you can access by pressing `CtrlE` and typing `help`. Additionally, you can
-view the help files online [here](https://github.com/zyedidia/micro/tree/master/runtime/help).
+view the help files here:
+
+* [main help](https://github.com/zyedidia/micro/tree/master/runtime/help/help.md)
+* [keybindings](https://github.com/zyedidia/micro/tree/master/runtime/help/keybindings.md)
+* [commands](https://github.com/zyedidia/micro/tree/master/runtime/help/commands.md)
+* [colors](https://github.com/zyedidia/micro/tree/master/runtime/help/colors.md)
+* [options](https://github.com/zyedidia/micro/tree/master/runtime/help/options.md)
+* [plugins](https://github.com/zyedidia/micro/tree/master/runtime/help/plugins.md)
 
 I also recommend reading the [tutorial](https://github.com/zyedidia/micro/tree/master/runtime/help/tutorial.md) for
 a brief introduction to the more powerful configuration features micro offers.
@@ -125,3 +149,5 @@ a brief introduction to the more powerful configuration features micro offers.
 If you find any bugs, please report them! I am also happy to accept pull requests from anyone.
 
 You can use the Github issue tracker to report bugs, ask questions, or suggest new features.
+
+For a more informal setting to discuss the editor, you can join the [Gitter chat](https://gitter.im/zyedidia/micro).