Merge branch 'view-refactor'

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

diff --git a/runtime/syntax/README.md b/runtime/syntax/README.md
index 14243150d9b65ccc47ee3ac4d74fa206cf8ccccd..cb4df5ae93aed8c709737362d7b17d36a5723803 100644 (file)
--- a/runtime/syntax/README.md
+++ b/runtime/syntax/README.md
@@ -1,3 +1,32 @@
+<<<<<<< HEAD
+# 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
@@ -7,7 +36,7 @@ They are taken from Nano, specifically from [this repository](https://github.com
 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) ".*"`
+    * For example, `icolor green ".*"` would become `color green "(?i).*"`
 
 # Using with colorschemes
 
@@ -38,3 +67,4 @@ Here is a list of the files that have been converted to properly use colorscheme
 
 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).
+>>>>>>> master