X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;ds=sidebyside;f=runtime%2Fsyntax%2FREADME.md;h=7d1a9de4c18dc2b2b3f909347aae19f1935f2c41;hb=54c23cae72d7237bc898a59f79aad0acffdf0ffe;hp=c3339ed95afb8a0d5c0efdf7c4325afd8892fb11;hpb=d949b58fc0a30b1d255abe8761fb4d8f417bade8;p=micro.git

diff --git a/runtime/syntax/README.md b/runtime/syntax/README.md
index c3339ed9..7d1a9de4 100644
--- a/runtime/syntax/README.md
+++ b/runtime/syntax/README.md
@@ -1,3 +1,31 @@
+# Syntax Files
+
+Here are micro's syntax files.
+
+Each yaml file specifies how to detect the filetype based on file extension or headers (first line of the file).
+Then there are patterns and regions linked to highlight groups which tell micro how to highlight that filetype.
+
+Making your own syntax files is very simple. I recommend you check the file after you are finished with the
+[`syntax_checker.go`](./syntax_checker.go) program (located in this directory). Just place your yaml syntax
+file in the current directory and run `go run syntax_checker.go` and it will check every file. If there are no
+errors it will print `No issues!`.
+
+You can read more about how to write syntax files (and colorschemes) in the [colors](../help/colors.md) documentation.
+
+# Legacy '.micro' filetype
+
+Micro used to use the `.micro` filetype for syntax files which is no longer supported. If you have `.micro`
+syntax files that you would like to convert to the new filetype, you can use the [`syntax_converter.go`](./syntax_converter.go) program (also located in this directory):
+
+```
+$ go run syntax_converter.go c.micro > c.yaml
+```
+
+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
@@ -36,5 +64,4 @@ Here is a list of the files that have been converted to properly use colorscheme
 
 # 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).
+See [LICENSE](LICENSE).