From 071b71bf0ccb0fba2f5bd84bb0b9572c5f1880c0 Mon Sep 17 00:00:00 2001 From: Brian Evans Date: Tue, 3 Mar 2020 13:09:45 -0800 Subject: Cleaning up comments and adding to readme --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 36a35b4..a69f5a2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Gemini Vim Syntax -This repo contains basic syntax highlighting for the [Gemini protocol](https://gemini.circumlunar.space/)'s *text/gemini* format. +This repo contains basic syntax highlighting for the [Gemini protocol](https://gemini.circumlunar.space/)'s **text/gemini** format. ## How to install @@ -30,7 +30,15 @@ The current state of the syntax covers all items officially supported by the [ge I plan to update the syntax when and if the spec adds more items to *text/gemini*. -## Unexpected + +## Filetype + +This syntax is set up to be used with files labled with the **gmi** extension. For example: +``` +$ vim my_gemini_map.gmi +``` + +## Surprises It is possible that Windows users may find that the syntax does not work. I do not have a machine to test it on and would love some feedback. If it is not working it likely has to do with line endings. Windows uses \<\ and linux/unix use just \. There are a number of ways to solve this problem ranging from just replacing the newlines manually to using software. In either case it shouldn't be too difficult. -- cgit v1.2.3-54-g00ecf