mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
3d3670bc65
rust/src/etc/emacs
History
Niko Matsakis 0fefd835f2 Update emacs and vi modes.
2014-12-14 04:21:57 -05:00
..
README.md Recommend autoload instead of require 2014-05-03 16:36:54 -04:00
run_rust_emacs_tests.sh emacs: Add shebang to test script 2014-06-17 16:39:40 -07:00
rust-mode-tests.el Fix spelling mistakes in comments. 2014-10-25 23:11:17 -04:00
rust-mode.el Update emacs and vi modes. 2014-12-14 04:21:57 -05:00

README.md

rust-mode: A major Emacs mode for editing Rust source code

rust-mode makes editing Rust code with Emacs enjoyable.

Manual Installation

To install manually, check out this repository and add this to your .emacs file:

(add-to-list 'load-path "/path/to/rust-mode/")
(autoload 'rust-mode "rust-mode" nil t)
(add-to-list 'auto-mode-alist '("\\.rs\\'" . rust-mode))

This associates rust-mode with .rs files. To enable it explicitly, do M-x rust-mode.

package.el installation via Marmalade or MELPA

It can be more convenient to use Emacs's package manager to handle installation for you if you use many elisp libraries. If you have package.el but haven't added Marmalade or MELPA, the community package source, yet, add this to ~/.emacs.d/init.el:

Using Marmalade:

(require 'package)
(add-to-list 'package-archives
             '("marmalade" . "http://marmalade-repo.org/packages/"))
(package-initialize)

Using MELPA:

(require 'package)
(add-to-list 'package-archives
             '("melpa" . "http://melpa.milkbox.net/packages/") t)
(package-initialize)

Then do this to load the package listing:

  • M-x eval-buffer
  • M-x package-refresh-contents

If you use a version of Emacs prior to 24 that doesn't include package.el, you can get it from here.

If you have an older ELPA package.el installed from tromey.com, you should upgrade in order to support installation from multiple sources. The ELPA archive is deprecated and no longer accepting new packages, so the version there (1.7.1) is very outdated.

Install rust-mode

One you have package.el, you can install rust-mode or any other modes by choosing them from a list:

  • M-x package-list-packages

Now, to install packages, move your cursor to them and press i. This will mark the packages for installation. When you're done with marking, press x, and ELPA will install the packages for you (under ~/.emacs.d/elpa/).

  • or using M-x package-install rust-mode

Tests via ERT

The file rust-mode-tests.el contains tests that can be run via ERT. You can use run_rust_emacs_tests.sh to run them in batch mode, if Emacs is somewhere in your $PATH.