Merge branch 'master' into work
[erlware-mode.git] / README
blobe188d5fb71730e7259d180d49e78621661b8b4cf
1 User configuration notes
2 ========================
4 Below is a quick guide to necessary configurations for getting
5 started with the Erlang mode for Emacs. Please refer to the
6 Users guide and reference manual in the documentation for the
7 Erlang/OTP application tools for more information.
10 For UNIX users
11 --------------
13 To set up the Erlang Emacs mode on UNIX systems, edit/create the file
14 .emacs in the your home directory.
15     
16 Below is a complete example of what should be added to a user's .emacs
17 provided that OTP is installed in the directory /usr/local/otp:
18         
19       (setq load-path (cons "<path-to-mode>/erlware-mode"
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)
26 For Windows users
27 -----------------
28    
29 To set up the Erlang Emacs mode on Windows systems, edit/create the
30 file .emacs, the location of the file depends on the configuration of
31 the system. If the HOME environment variable is set, Emacs will look
32 for the .emacs file in the directory indicated by the HOME
33 variable. If HOME is not set, Emacs will look for the .emacs file in
34 C:\.
35     
36 Below is a complete example of what should be added to a user's .emacs
37 provided that OTP is installed in the directory C:\Program
38 Files\erl-<Ver>:
39       
40       (setq load-path (cons  "<path-to-mode>/erlware-mode"
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