README
1User configuration notes
2========================
3
4Below is a quick guide to necessary configurations for getting
5started with the Erlang mode for Emacs. Please refer to the
6Users guide and reference manual in the documentation for the
7Erlang/OTP application tools for more information.
8
9
10For UNIX users
11--------------
12
13To set up the Erlang Emacs mode on UNIX systems, edit/create the file
14.emacs in the your home directory.
15
16Below is a complete example of what should be added to a user's .emacs
17provided that OTP is installed in the directory /usr/local/otp:
18
19 (setq load-path (cons "/usr/local/otp/lib/tools-<ToolsVer>/emacs"
20 load-path))
21 (setq erlang-root-dir "/usr/local/otp")
22 (setq exec-path (cons "/usr/local/otp/bin" exec-path))
23 (require 'erlang-start)
24
25
26For Windows users
27-----------------
28
29To set up the Erlang Emacs mode on Windows systems, edit/create the
30file .emacs, the location of the file depends on the configuration of
31the system. If the HOME environment variable is set, Emacs will look
32for the .emacs file in the directory indicated by the HOME
33variable. If HOME is not set, Emacs will look for the .emacs file in
34C:\.
35
36Below is a complete example of what should be added to a user's .emacs
37provided that OTP is installed in the directory C:\Program
38Files\erl-<Ver>:
39
40 (setq load-path (cons "C:/Program Files/erl<Ver>/lib/tools-<ToolsVer>/emacs"
41 load-path))
42 (setq erlang-root-dir "C:/Program Files/erl<Ver>")
43 (setq exec-path (cons "C:/Program Files/erl<Ver>/bin" exec-path))
44 (require 'erlang-start)
45
46
47Miscellaneous addons
48--------------------
49
50In order to check erlang source code on the fly, add the following
51line to your .emacs file (after erlang-start, see above). See
52erlang-flymake.el for more information on how to customize the syntax
53check.
54
55 (require 'erlang-flymake)
56