@@ -8,6 +8,9 @@ Provides font-locking, indentation and navigation support for the
88[ Elixir programming language.] ( http://elixir-lang.org/ )
99
1010- [ Installation] ( #installation )
11+ - [ ELPA] ( #installation-via-packageel )
12+ - [ Via el-get] ( #via-el-get )
13+ - [ Manual] ( #manual )
1114- [ Usage] ( #usage )
1215 - [ Interactive Commands] ( #interactive-commands )
1316 - [ Configuration] ( #configuration )
@@ -20,44 +23,54 @@ Provides font-locking, indentation and navigation support for the
2023
2124## Installation
2225
23- ### (M)ELPA
26+ ### Installation via package.el
2427
25- If you're not already using ELPA, check the
26- [ emacswiki] ( http://www.emacswiki.org/emacs/ELPA ) page to get familiar with it.
27- ` elixir-mode ` is available on [ MELPA] ( http://stable.melpa.org/ ) , the community
28- maintained repository.
28+ ` package.el ` is the built-in package manager in Emacs.
2929
30- 1 . Add the (stable) package source: ` http://stable.melpa.org/packages/ `
31- 2 . Install ` elixir-mode ` package
30+ ` Elixir-Mode ` is available on the two major community maintained repositories -
31+ [ MELPA STABLE ] ( melpa-stable.milkbox.net ) and [ MELPA ] ( http://melpa.milkbox.net ) .
3232
33+ You can install ` Elixir-Mode ` with the following commnad:
3334
34- [ In your emacs initialization file: ] ( http://stable.melpa.org/#/getting-started )
35+ < kbd >M-x package-install [ RET ] elixir-mode [ RET ] </ kbd >
3536
36- (add-to-list 'package-archives
37- '("melpa-stable" . "http://stable.melpa.org/packages/") t)
37+ or by adding this bit of Emacs Lisp code to your Emacs initialization file
38+ ( ` .emacs ` or ` init.el ` ):
3839
39- In your emacs:
40+ ``` el
41+ (unless (package-installed-p 'elixir-mode)
42+ (package-install 'elixir-mode))
43+ ```
44+
45+ If the installation doesn't work try refreshing the package list:
4046
41- M-x package-install
42- elixir-mode
47+ <kbd >M-x package-refresh-contents [ RET] </kbd >
4348
44- ** Please take note of the [ packages URL] ( http://stable.melpa.org/packages/ ) !**
45- We strive for the most responsible release management possible (to the best
46- of our knowledge & abilities). To that end, please ensure you are * only* using
47- [ MELPA Stable] ( http://stable.melpa.org ) . If you use
48- [ regular MELPA] ( http://melpa.org ) , you will be installing the * latest changes
49- to master* , not the latest release.
49+ Keep in mind that MELPA packages are built automatically from
50+ the ` master ` branch, meaning bugs might creep in there from time to
51+ time. Never-the-less, installing from MELPA is the recommended way of
52+ obtaining ` Elixir-Mode ` , as the ` master ` branch is normally quite stable and
53+ "stable" (tagged) builds are released somewhat infrequently.
5054
51- ### Download latest release
55+ With the most recent builds of Emacs, you can pin ` Elixir-Mode ` to always
56+ use MELPA Stable by adding this to your Emacs initialization:
5257
53- If you would prefer to install from source, you can download the latest tagged
54- release from https://github.com/elixir-lang/emacs-elixir/releases/latest/ .
58+ ``` el
59+ (add-to-list 'package-pinned-packages '(elixir-mode . "melpa-stable") t)
60+ ```
5561
56- After unzipping either the tarball or zipfile into your desired location,
57- add the following in your .emacs file:
62+ ### Via el-get
5863
59- ``` lisp
60- (add-to-list 'load-path "~/path/to/emacs-elixir/")
64+ [ el-get] ( https://github.com/dimitri/el-get ) is another popular package manager for Emacs. If you're an el-get
65+ user just do <kbd >M-x el-get-install [ RET] elixir-mode [ RET] </kbd >.
66+
67+ ### Manual
68+
69+ You can install ` Elixir-Mode ` manually by placing ` Elixir-Mode ` on your ` load-path ` and
70+ ` require ` ing it. Many people favour the folder ` ~/.emacs.d/vendor ` .
71+
72+ ``` el
73+ (add-to-list 'load-path "~/.emacs.d/vendor")
6174(require 'elixir-mode)
6275```
6376
0 commit comments