1 files changed, 92 insertions, 0 deletions
diff --git a/data/sisu/conf/syntax/README b/data/sisu/conf/syntax/README
new file mode 100644
index 00000000..04c0ea09
--- /dev/null
+++ b/data/sisu/conf/syntax/README
@@ -0,0 +1,92 @@
+This directory
+  sisu-examples/sisu-examples/config/syntax_hi/
+  /usr/share/sisu-examples/sisu-examples/config/syntax_hi
+contains rudimentary sisu syntax highlighting files for:
+
+* (g)vim http://www.vim.org
+  * package: sisu-vim
+  * status: largely done
+  * comments: not found here
+    a vim syntax highlighting and folds component of sisu exists,
+    see sisu-vim
+
+* gedit http://www.gnome.org/projects/gedit
+* gobby http://gobby.0x539.de/
+  file: sisu.lang
+  place in:
+    /usr/share/gtksourceview-1.0/language-specs
+  or
+    ~/.gnome2/gtksourceview-1.0/language-specs
+  * status: very basic syntax highlighting
+  * comments: this editor features display line wrap and is used by Goby!
+
+* nano http://www.nano-editor.org
+  file: nanorc
+  save as:
+    ~/.nanorc
+  includes:
+  * status: basic syntax highlighting
+  * comments: assumes dark background
+    no display line-wrap
+    does line breaks
+
+* diakonos (an editor written in ruby) http://purepistos.net/diakonos
+  file: diakonos.conf
+  save as:
+    ~/.diakonos/diakonos.conf
+  includes:
+  * status: basic syntax highlighting
+  * comments: assumes dark background
+    no display line-wrap
+
+* kate & kwrite http://kate.kde.org
+  file: sisu.xml
+  place in:
+    /usr/share/apps/katepart/syntax
+  or
+    ~/.kde/share/apps/katepart/syntax
+  [settings::configure kate::{highlighting,filetypes}]
+  [tools::highlighting::{markup,scripts}::SiSU]
+
+* nedit http://www.nedit.org
+  file: sisu_nedit.pats
+  nedit -import sisu_nedit.pats
+  * status: a very clumsy first attempt
+  [not really done]
+  * comments: this editor features display line wrap
+
+* emacs http://www.gnu.org/software/emacs/emacs.html
+  files: sisu-mode.el
+  to file ~/.emacs add the following 2 lines:
+    (add-to-list 'load-path "/usr/share/sisu-examples/config/syntax_hi")
+    (require 'sisu-mode.el)
+  [not done / not yet included]
+
+* vim & gvim http://www.vim.org
+  files: sisu-vim http://www.jus.uio.no/sisu/SiSU/download
+  package is the most comprehensive sisu syntax highlighting and editor
+  environment provided to date (is for vim/ gvim, and is separate from the
+  contents of this directory)
+  on debian:
+    aptitude install sisu-vim
+  * status: this includes:
+    syntax highlighting
+    vim folds
+    some error checking
+  * comments: this editor features display line wrap
+
+NOTE: 
+
+[SiSU parses files with long lines or line breaks, 
+but, display linewrap (without line-breaks) is a 
+convenient editor feature to have for sisu markup]
+
+kde-config --prefix
+KDEDIR/share/apps/katepart/syntax/ 
+KDEHOME/share/apps/katepart/syntax
+[In the configure dialog in kate, go to the "Editor->highlighting" page and 
+>select a highlight to change the mimetype/pattern associations for it.]    
+/etc/mime.types
+/usr/share/mime/text
+# 
+# * aeditor (an editor written in ruby)