Explain the project

README.md

@@ -0,0 +1,13 @@
+# vim-syntax-gemtext
+
+This project adds a Gemtext syntax mode for [vim](https://www.vim.org), with syntax highlighting and file type detection.
+
+## Setup
+
+Copy `syntax/gemtext.vim` to `~/.vim/syntax/gemtext.vim`.
+
+> This file describes the "gemtext" syntax mode. It matches the `text/gemini` MIME type described by section 5 of the [Gemini Specification](https://gemini.circumlunar.space/docs/specification.html).
+
+Copy `ftdetect/gemtext.vim` to `~/.vim/ftdetect/gemtext.vim`.
+
+> This file associates Gemtext syntax with files ending in ".gmi" and ".gemini".

ftdetect/gemtext.vim

@@ -1,6 +1,4 @@
 " Vim file type detection for Gemtext markup
 
-" Add this file to ~/.vim/ftdetect/gemtext.vim
-
 au BufRead,BufNewFile *.gmi set filetype=gemtext
 au BufRead,BufNewFile *.gemini set filetype=gemtext

syntax/gemtext.vim

@@ -2,8 +2,6 @@
 " as described by section 5 of the Gemini Specification
 " https://gemini.circumlunar.space/docs/specification.html
 
-" Add this file to ~/.vim/syntax/gemtext.vim
-
 if exists("b:current_syntax")
     finish
 endif
@@ -37,4 +35,3 @@ hi def link gemtextQuoteOperator Operator
 hi def link gemtextQuoteText String
 
 hi def link gemtextPreformatBlock PreProc
-