Rename interpretor to interpreter.

[Faustine.git] / interpreter / preprocessor / faust-0.9.47mr3 / syntax-highlighting / README

diff --git a/interpreter/preprocessor/faust-0.9.47mr3/syntax-highlighting/README b/interpreter/preprocessor/faust-0.9.47mr3/syntax-highlighting/README
new file mode 100644 (file)
index 0000000..c9eac98
--- /dev/null
+++ b/interpreter/preprocessor/faust-0.9.47mr3/syntax-highlighting/README
@@ -0,0 +1,39 @@
+Faust Syntax Highlighting Files
+-------------------------------
+
+This folder contains syntax highlighting files for various editors. The editors currently supported are : KDE Kate/Kwrite, GNOME gedit, Macintosh TextWrangler, highlight and vim
+
+1) KDE Kate/Kwrite
+install the file 'faust.xml' into Kate syntax folder ('/opt/kde3/share/apps/katepart/syntax' on suse 10.0)
+('/usr/share/apps/katepart/syntax' on mandriva and ubuntu)
+
+2) gedit
+Install the file 'faust.lang' into gedit syntax folder ('/usr/share/gtksourceview-2.0/language-specs' on Ubuntu 9.10)
+
+
+3) TextWrangler
+install the file Faust.plist into ~/Library/Application\ Support/TextWrangler/Language\ Modules/
+
+4) Highlight
+install dsp.lang into /usr/share/highlight/langDefs/
+Examples using highlight :
+       highlight --latex -l -t 4 -i karplus.dsp -o karplus.dsp.tex
+       highlight -l -t 4 -i mixer.dsp -o mixer.dsp.html
+
+5) VIM
+'faust.vim' is a syntax file for VIM contributed by Björn Lindig
+- install the file 'faust.vim' into vim syntax folder ('~/.vim/syntax/')
+- add the following lines to the file 'filetype.vim' in the '~/.vim' directory (if its not there, you have to create it):
+
+faust filetype file
+    if exists("did_load_filetypes")
+      finish
+    endif
+    augroup filetypedetect
+      au! BufRead,BufNewFile *.fst      setfiletype faust
+      au! BufRead,BufNewFile *.dsp      setfiletype faust
+    augroup END
+
+6) EMACS
+An EMACS Faust mode is provided by Juan Gabriel Alzate Romero at https://github.com/rukano/emacs-faust-mode
+