From 0cb58510bb49c52a983a7dd8c94f1f5dd2e70e30 Mon Sep 17 00:00:00 2001
From: Tim Allen <screwtape@froup.com>
Date: Wed, 14 Jan 2009 00:05:38 +1100
Subject: [PATCH] Move Vim syntax-highlighter to a Vim subdirectory.

This makes it easier to describe where the syntax-highlighting file
should be installed, and allows us to easily package other Vim runtime
files.

This commit also adds a README that describes how to regenerate the
syntax file.
---
 .../generate-syntax/generate-syntax.factor    |  2 +-
 misc/vim/README                               | 25 +++++++++++++++++++
 misc/{ => vim/syntax}/factor.vim              |  0
 3 files changed, 26 insertions(+), 1 deletion(-)
 create mode 100644 misc/vim/README
 rename misc/{ => vim/syntax}/factor.vim (100%)

diff --git a/basis/editors/vim/generate-syntax/generate-syntax.factor b/basis/editors/vim/generate-syntax/generate-syntax.factor
index 74b04c346f..061e938dcf 100644
--- a/basis/editors/vim/generate-syntax/generate-syntax.factor
+++ b/basis/editors/vim/generate-syntax/generate-syntax.factor
@@ -4,7 +4,7 @@ IN: editors.vim.generate-syntax
 
 : generate-vim-syntax ( -- )
     "misc/factor.vim.fgen" resource-path <fhtml>
-    "misc/factor.vim" resource-path
+    "misc/vim/syntax/factor.vim" resource-path
     template-convert ;
 
 MAIN: generate-vim-syntax
diff --git a/misc/vim/README b/misc/vim/README
new file mode 100644
index 0000000000..1e82708ba4
--- /dev/null
+++ b/misc/vim/README
@@ -0,0 +1,25 @@
+Vim support for Factor
+----------------------
+
+This directory contains various support files that make editing Factor code
+more pleasant in Vim. The file-layout exactly matches the Vim runtime
+structure, so you can install them by copying the contents of this directory
+into ~/.vim/ or the equivalent path on other platforms (Open Vim and type
+":help 'runtimepath'" for details).
+
+The current set of files is as follows:
+
+    syntax/factor.vim
+        Syntax highlighting for Factor code.
+
+Note: The syntax-highlighting file is automatically generated to include the
+names of all the vocabularies Factor knows about. To regenerate it manually,
+run the following code in the listener:
+
+    USE: editors.vim.generate-syntax
+
+    generate-vim-syntax
+
+...or run it from the command-line:
+
+    factor -run=editors.vim.generate-syntax
diff --git a/misc/factor.vim b/misc/vim/syntax/factor.vim
similarity index 100%
rename from misc/factor.vim
rename to misc/vim/syntax/factor.vim