branch: elpa/go-mode
commit 0bcbcf12730049d685e02f9e9451554d56f71f99
Author: Dominik Honnef <[email protected]>
Commit: Dominik Honnef <[email protected]>
refine install instructions
---
README.md | 27 +++++++++++++++++++--------
1 file changed, 19 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 6aab25d..c15149e 100644
--- a/README.md
+++ b/README.md
@@ -43,19 +43,30 @@ the following extra features to provide an improved
experience:
# Installation
-Put go-mode.el into a directory of your choice and add an instruction in the
-Emacs init file to load it
+## MELPA
- (add-to-list 'load-path "/place/where/you/put/it/")
+The recommended way of installing go-mode is via
+[ELPA](http://www.emacswiki.org/emacs/ELPA), the Emacs package
+manager, and the
+[MELPA repository](http://melpa.org/#/getting-started), which provides
+an up-to-date version of go-mode.
-From within Emacs, run M-x update-file-autoloads, point it at the
-go-mode.el file and tell it to generate a go-mode-load.el file.
+## Manual
-To the Emacs init file add
+To install go-mode manually, place `go-mode.el` and
+`go-mode-autoloads.el` in a directory of your choice, add it to your
+load path and require `'go-mode-autoloads`:
- (require 'go-mode-load)
+ (add-to-list 'load-path "/place/where/you/put/it/")
+ (require 'go-mode-autoloads)
-Restart Emacs.
+Either evaluate both statements with `C-x C-e`, or restart Emacs.
+
+As a side note, normally the autoloads file shouldn't be part of the
+package, as it's supposed to be automatically generated by ELPA, or
+manually by the user with `update-file-autoloads`. go-mode includes
+said file because it used to when it was part of the Go distribution
+and this makes upgrading easier for some people.
# Other extensions
