about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorKartik Agaram <vc@akkartik.com>2020-05-23 00:24:13 -0700
committerKartik Agaram <vc@akkartik.com>2020-05-23 00:24:13 -0700
commit7852e65c7f18c5077111ff7ea453c15758e50506 (patch)
tree07d2cb57432068739e7883fdc1c7d5cce89a0140
parent6b43542f6c960ad71b7af315263c856ec7dda811 (diff)
downloadmu-7852e65c7f18c5077111ff7ea453c15758e50506.tar.gz
6386 - documentation on editor setup
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index 423381ac..d6534db6 100644
--- a/README.md
+++ b/README.md
@@ -359,6 +359,22 @@ of these invariants is broken it's a bug on my part.
   building general infrastructure here for all of the x86 instruction set.
   SubX is about programming with a small, regular subset of 32-bit x86.
 
+## Getting your editor set up
+
+If you've read this far, it's time to set up your editor. Mu is really
+intended to be read interactively rather than on a browser.
+
+There is rudimentary syntax highlighting support for Mu and SubX files for
+various editors. Look for your editor in `mu.*` and `subx.*`, and follow the
+instructions within.
+
+The Vim files are most developed. In particular, I recommend some optional
+setup in subx.vim to use multiple colors for comments.
+
+If you use [Exuberant Ctags](http://ctags.sourceforge.net) for jumping easily
+from names to their definitions in your editor, copy the contents of `exuberant_ctags_rc`
+into your `.ctags` file.
+
 ## A few hints for debugging
 
 Writing programs in SubX is surprisingly pleasant and addictive. Reading