Merge

[micro.git] / runtime / syntax / README.md

diff --git a/runtime/syntax/README.md b/runtime/syntax/README.md
index 12bc6809e3af60bb9f12f6cea093ff9d14278059..2d4e42dbf1fbd2e0dbe88d96f6b9271505b13644 100644 (file)
--- a/runtime/syntax/README.md
+++ b/runtime/syntax/README.md
@@ -25,3 +25,44 @@ Most the the syntax files here have been converted using that tool.
 
 Note that the tool isn't perfect and though it is unlikely, you may run into some small issues that you will have to fix manually
 (about 4 files from this directory had issues after being converted).
+
+# Micro syntax highlighting files
+
+These are the syntax highlighting files for micro. To install them, just
+put all the syntax files in `~/.config/micro/syntax`.
+
+They are taken from Nano, specifically from [this repository](https://github.com/scopatz/nanorc).
+Micro syntax files are almost identical to Nano's, except for some key differences:
+
+* Micro does not use `icolor`. Instead, for a case insensitive match, use the case insensitive flag (`i`) in the regular expression
+    * For example, `icolor green ".*"` would become `color green "(?i).*"`
+
+# Using with colorschemes
+
+Not all of these files have been converted to use micro's colorscheme feature. Most of them just hardcode the colors, which can be problematic depending on the colorscheme you use.
+
+Here is a list of the files that have been converted to properly use colorschemes:
+
+* vi
+* go
+* c
+* d
+* markdown
+* html
+* lua
+* swift
+* rust
+* java
+* javascript
+* pascal
+* python
+* ruby
+* sh
+* git
+* tex
+* solidity
+
+# License
+
+Because the nano syntax files I have modified are distributed under the GNU GPLv3 license, these files are also distributed
+under that license. See [LICENSE](LICENSE).