aboutsummaryrefslogtreecommitdiff
path: root/utils/emacs/README
diff options
context:
space:
mode:
Diffstat (limited to 'utils/emacs/README')
-rw-r--r--utils/emacs/README27
1 files changed, 27 insertions, 0 deletions
diff --git a/utils/emacs/README b/utils/emacs/README
new file mode 100644
index 000000000000..e83eeae4b070
--- /dev/null
+++ b/utils/emacs/README
@@ -0,0 +1,27 @@
+-*- llvm/utils/emacs/README -*-
+
+These are syntax highlighting files for the Emacs and XEmacs editors. Included
+are:
+
+* llvm-mode.el
+
+ Syntax highlighting mode for LLVM assembly files. To use, add this code to
+ your ~/.emacs :
+
+ (setq load-path
+ (cons (expand-file-name "path-to-llvm/utils/emacs") load-path))
+ (require 'llvm-mode)
+
+* tablegen-mode.el
+
+ Syntax highlighting mode for TableGen description files. To use, add this code
+ to your ~/.emacs:
+
+ (setq load-path
+ (cons (expand-file-name "path-to-llvm/utils/emacs") load-path))
+ (require 'tablegen-mode)
+
+
+Note: If you notice missing or incorrect syntax highlighting, please contact
+<llvmbugs [at] cs.uiuc.edu>; if you wish to provide a patch to improve the
+functionality, it will be most appreciated. Thank you.