Skip to content

Commit cdb3637

Browse files
committed
Update README to mention autoloads generation
This is only needed for the "manual installation" of snapshots. Any future proper release tar-balls created by `make dist` will contain a generated `haskell-site-file.el` file. This should fix #152 (which was caused by ae7cee0).
1 parent 314a780 commit cdb3637

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -87,23 +87,33 @@ $ apt-get install haskell-mode
8787

8888
### Manual
8989

90-
- Download and unpack the basic mode and modules into a suitable directory,
91-
e.g. ~/lib/emacs/haskell-mode/ where ~ stands for your home directory.
90+
91+
- Download and unpack (for instance by by `git clone`) the basic mode and modules
92+
into a suitable directory, e.g. `~/lib/emacs/haskell-mode/` where `~` stands for
93+
your home directory.
9294

9395
- If you are using Emacs 21, you need an additional library, "syntax", from
9496
a later version of Emacs. The one you can get as
9597
http://cvs.savannah.gnu.org/viewcvs/*checkout*/emacs/emacs/lisp/emacs-lisp/syntax.el?rev=1.16
9698
definitely works.
9799

98-
- Assuming you have placed the basic mode haskell-mode.el and the modules
99-
you want to use in the directory ~/lib/emacs/haskell-mode/, add the
100-
following command to your init file (~/.emacs):
100+
- Assuming you have placed the basic mode (`haskell-mode.el`) and the other modules
101+
you want to use in the directory ~/lib/emacs/haskell-mode/, you need generate the
102+
autoloads file (`haskell-site-file.el`) by either
103+
104+
- Invoking `make all` or `make haskell-site-file.el`, or
105+
106+
- From inside Emacs, `M-x update-directory-autoloads` and answering the question for
107+
the folder with `~/lib/emacs/haskell-mode/` and the question for the output-file with
108+
`~/lib/emacs/haskell-mode/haskell-site-file.el`
109+
110+
and then adding the following command to your init file (`~/.emacs` or `~/.emacs.d/init.el`):
101111

102112
```lisp
103113
(load "~/lib/emacs/haskell-mode/haskell-site-file")
104114
```
105115
106-
This only loads the bare-bones haskell-mode. To make it useful, you
116+
However, this only loads the bare-bones haskell-mode. To make it useful, you
107117
need additional modules; you can use the haskell `customize-group`
108118
to edit the Haskell mode hook or, if you prefer manual setup, try
109119
adding the following lines according to which modules you want to use:

0 commit comments

Comments
 (0)