OpenE2K/rust
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Minor cleanup and formatting tweaks to the rust-mode README

Browse Source
This commit is contained in:
Lindsey Kuper 2013-09-13 20:42:40 -04:00
parent 150b4ffccc
commit 462dcc8e7a
1 changed files with 28 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
src/etc/emacs/README.md
View File

@ -1,27 +1,29 @@
rust-mode: A major emacs mode for editing Rust source code
==========================================================
`rust-mode`: A major Emacs mode for editing Rust source code
============================================================
`rust-mode` makes editing [Rust](http://rust-lang.org) code with emacs
`rust-mode` makes editing [Rust](http://rust-lang.org) code with Emacs
enjoyable.
### Manual Installation
To install manually, check out this repository and add this to your .emacs
file:
To install manually, check out this repository and add this to your
`.emacs` file:
(add-to-list 'load-path "/path/to/rust-mode/")
(require 'rust-mode)
```lisp
(add-to-list 'load-path "/path/to/rust-mode/")
(require 'rust-mode)
```
Rust mode will automatically be associated with .rs files. To enable it
explicitly, do `M-x rust-mode`.
`rust-mode` will automatically be associated with `.rs` files. To enable it
explicitly, do <kbd>M-x rust-mode</kbd>.
### package.el installation via Marmalade or MELPA
### `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:
`package.el` but haven't added Marmalade or MELPA, the community
package source, yet, add this to `~/.emacs.d/init.el`:
Using Marmalade:
@ -47,32 +49,33 @@ Then do this to load the package listing:
* <kbd>M-x package-refresh-contents</kbd>
If you use a version of Emacs prior to 24 that doesn't include
package.el, you can get it from http://bit.ly/pkg-el23.
`package.el`, you can get it from [here](http://bit.ly/pkg-el23).
If you have an older ELPA package.el installed from tromey.com, you
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
#### Install `rust-mode`
From there you can install rust-mode or any other modes by choosing
them from a list:
One you have `package.el`, you can install `rust-mode` or any other
modes by choosing them from a list:
* <kbd>M-x package-list-packages</kbd>
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/).
Now, to install packages, move your cursor to them and press
<kbd>i</kbd>. This will mark the packages for installation. When
you're done with marking, press <kbd>x</kbd>, and ELPA will install
the packages for you (under `~/.emacs.d/elpa/`).
* or using <kbd>M-x package-install rust-mode
* or using <kbd>M-x package-install rust-mode</kbd>
### 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`.
The file `rust-mode-tests.el` contains tests that can be run via
[ERT](http://www.gnu.org/software/emacs/manual/html_node/ert/index.html).
You can use `run_rust_emacs_tests.sh` to run them in batch mode, if
Emacs is somewhere in your `$PATH`.
### Known bugs