1
- ` rust-mode ` : A major Emacs mode for editing Rust source code
2
- ============================================================
1
+ rust-mode: A major emacs mode for editing Rust source code
2
+ ==========================================================
3
3
4
- ` rust-mode ` makes editing [ Rust] ( http://rust-lang.org ) code with Emacs
4
+ ` rust-mode ` makes editing [ Rust] ( http://rust-lang.org ) code with emacs
5
5
enjoyable.
6
6
7
7
8
8
### Manual Installation
9
9
10
- To install manually, check out this repository and add this to your
11
- ` .emacs ` file:
10
+ To install manually, check out this repository and add this to your .emacs
11
+ file:
12
12
13
- ``` lisp
14
- (add-to-list 'load-path "/path/to/rust-mode/")
15
- (require 'rust-mode)
16
- ```
13
+ (add-to-list 'load-path "/path/to/rust-mode/")
14
+ (require 'rust-mode)
17
15
18
- ` rust- mode` will automatically be associated with ` .rs ` files. To enable it
19
- explicitly, do < kbd > M-x rust-mode</ kbd > .
16
+ Rust mode will automatically be associated with .rs files. To enable it
17
+ explicitly, do ` M-x rust-mode ` .
20
18
21
- ### ` package.el ` installation via Marmalade or MELPA
19
+ ### package.el installation via Marmalade or MELPA
22
20
23
21
It can be more convenient to use Emacs's package manager to handle
24
22
installation for you if you use many elisp libraries. If you have
25
- ` package.el ` but haven't added Marmalade or MELPA, the community
26
- package source, yet, add this to ` ~/.emacs.d/init.el ` :
23
+ package.el but haven't added Marmalade or MELPA, the community package source,
24
+ yet, add this to ~ /.emacs.d/init.el:
27
25
28
26
Using Marmalade:
29
27
@@ -49,33 +47,32 @@ Then do this to load the package listing:
49
47
* <kbd >M-x package-refresh-contents</kbd >
50
48
51
49
If you use a version of Emacs prior to 24 that doesn't include
52
- ` package.el ` , you can get it from [ here ] ( http://bit.ly/pkg-el23 ) .
50
+ package.el, you can get it from http://bit.ly/pkg-el23 .
53
51
54
- If you have an older ELPA ` package.el ` installed from tromey.com, you
52
+ If you have an older ELPA package.el installed from tromey.com, you
55
53
should upgrade in order to support installation from multiple sources.
56
54
The ELPA archive is deprecated and no longer accepting new packages,
57
55
so the version there (1.7.1) is very outdated.
58
56
59
- #### Install ` rust-mode `
57
+ #### Install rust-mode
60
58
61
- One you have ` package.el ` , you can install ` rust-mode ` or any other
62
- modes by choosing them from a list:
59
+ From there you can install rust-mode or any other modes by choosing
60
+ them from a list:
63
61
64
62
* <kbd >M-x package-list-packages</kbd >
65
63
66
- Now, to install packages, move your cursor to them and press
67
- < kbd >i</ kbd >. This will mark the packages for installation. When
68
- you're done with marking, press < kbd >x</ kbd > , and ELPA will install
69
- the packages for you (under ` ~/.emacs.d/elpa/ ` ).
64
+ Now, to install packages, move your cursor to them and press i. This
65
+ will mark the packages for installation. When you're done with
66
+ marking, press x , and ELPA will install the packages for you (under
67
+ ~ /.emacs.d/elpa/).
70
68
71
- * or using <kbd >M-x package-install rust-mode</ kbd >
69
+ * or using <kbd >M-x package-install rust-mode
72
70
73
71
### Tests via ERT
74
72
75
- The file ` rust-mode-tests.el ` contains tests that can be run via
76
- [ ERT] ( http://www.gnu.org/software/emacs/manual/html_node/ert/index.html ) .
77
- You can use ` run_rust_emacs_tests.sh ` to run them in batch mode, if
78
- Emacs is somewhere in your ` $PATH ` .
73
+ The file ` rust-mode-tests.el ` contains tests that can be run via ERT. You can
74
+ use ` run_rust_emacs_tests.sh ` to run them in batch mode, if emacs is somewhere
75
+ in your ` $PATH ` .
79
76
80
77
### Known bugs
81
78
0 commit comments