Add README for Vim editor plugin

This commit is contained in:
Matthias Krack 2019-03-13 17:27:00 +01:00
parent 264ff465c5
commit b2aeb7987b
2 changed files with 5 additions and 13 deletions

View file

@ -0,0 +1,5 @@
# Plugin for the Vim editor
For more information on
* obtaining and using the Vim editor plugin for CP2K, see [CP2K Tools:vim](https://www.cp2k.org/tools:vim)
* creating the Vim editor plugin file cp2k.vim, see [How to generate the CP2K input reference manual](https://manual.cp2k.org/trunk/generate_manual_howto.html)

View file

@ -1,13 +0,0 @@
#!/bin/sh
# Generate XML dump of the CP2K input structure
# Change CP2K executable file name as needed
../../exe/Linux-x86-64-gfortran/cp2k.popt --xml
# Provide path to saxon package
export SAXON=/usr/share/java/saxon8.jar
# saxon -o index.html cp2k_input.xml cp2k_input.xsl
# Java version from http://sourceforge.net/projects/saxon
# For Saxon 9 HE syntax has changed, use -o:index.html
java -jar $SAXON -o cp2k.vim cp2k_input.xml vim.xsl
[[ -d ~/.vim/syntax ]] || mkdir -p ~/.vim/syntax
cp -i cp2k.vim ~/.vim/syntax
# Edit a CP2K input file with vim