From a2847eab5dc63b8b4dfbfce7b600665997690074 Mon Sep 17 00:00:00 2001 From: Midgard Date: Fri, 24 Jan 2020 01:50:06 +0100 Subject: [PATCH] Add README for Vim support --- etc/vim/README.md | 35 +++++++++++++++++++++++++++++++++++ etc/vim/indent.vim | 1 + 2 files changed, 36 insertions(+) create mode 100644 etc/vim/README.md create mode 100644 etc/vim/indent.vim diff --git a/etc/vim/README.md b/etc/vim/README.md new file mode 100644 index 0000000..5f616b0 --- /dev/null +++ b/etc/vim/README.md @@ -0,0 +1,35 @@ +# HLDS support in Vim + +Add syntax highlighting for HLDS, the Haldis Language for Describing Servings, to your editor! + +## Installation + +Install these files as + +* `ftdetect/hlds.vim` +* `ftplugin/hlds.vim` +* `syntax/hlds.vim` +* `indent/hlds.vim` + +in your Vim runtime directory. + +For example if you're using a *NIX such as Linux or macOS: +```sh +for kind in ftdetect ftplugin syntax indent; do + mkdir -p ~/.vim/$kind + cp $PWD/$kind.vim ~/.vim/$kind/hlds.vim +done +``` + +If you use [Neovim](https://neovim.io/) instead of Vim: +```sh +for kind in ftdetect ftplugin syntax indent; do + mkdir -p ~/.config/nvim/$kind + cp $PWD/$kind.vim ~/.config/nvim/$kind/hlds.vim +done +``` + +If you want to use the latest version, you can create symlinks instead of copying by substituting +`ln -s` for `cp`. + +Restart Vim to enable support for HLDS. diff --git a/etc/vim/indent.vim b/etc/vim/indent.vim new file mode 100644 index 0000000..c166793 --- /dev/null +++ b/etc/vim/indent.vim @@ -0,0 +1 @@ +" This file will be populated in the future