Clean up some duplication
[factor/jcg.git] / misc / vim / README
blobbede15145851aa207bc704ebd8884903fd047308
1 Vim support for Factor
2 ----------------------
4 This directory contains various support files that make editing Factor code
5 more pleasant in Vim. The file-layout exactly matches the Vim runtime
6 structure, so you can install them by copying the contents of this directory
7 into ~/.vim/ or the equivalent path on other platforms (Open Vim and type
8 ":help 'runtimepath'" for details).
10 The current set of files is as follows:
12     ftdetect/factor.vim
13         Teach Vim when to load Factor support files.
14     ftplugin/factor_settings.vim
15         Teach Vim to follow the Factor Coding Style guidelines.
16     syntax/factor.vim
17         Syntax highlighting for Factor code.
19 Note: The syntax-highlighting file is automatically generated to include the
20 names of all the vocabularies Factor knows about. To regenerate it manually,
21 run the following code in the listener:
23     USE: editors.vim.generate-syntax
25     generate-vim-syntax
27 ...or run it from the command-line:
29     factor -run=editors.vim.generate-syntax