[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/rust-mode 06b3b60 412/486: update readme (#327)
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/rust-mode 06b3b60 412/486: update readme (#327) |
Date: |
Sat, 7 Aug 2021 09:26:04 -0400 (EDT) |
branch: elpa/rust-mode
commit 06b3b60558f40e6eb1ac9b4720da0ae1fff08a29
Author: brotzeit <brotzeitmacher@gmail.com>
Commit: Nathan Moreau <nathan.moreau@m4x.org>
update readme (#327)
---
README.md | 103 +++++++++++++++++++++--------------------------------------
rust-mode.el | 2 +-
2 files changed, 38 insertions(+), 67 deletions(-)
diff --git a/README.md b/README.md
index 34e3f92..34a3fc2 100644
--- a/README.md
+++ b/README.md
@@ -1,96 +1,67 @@
-`rust-mode`: A major Emacs mode for editing Rust source code
-============================================================
+[![MELPA](https://melpa.org/packages/rust-mode-badge.svg)](https://melpa.org/#/rust-mode)
-`rust-mode` makes editing [Rust](http://rust-lang.org) code with Emacs
-enjoyable. `rust-mode` requires Emacs 24 or later.
-
-## Installation
-
-### Manual Installation
+# Emacs mode for editing Rust source code
-To install manually, check out this repository and add this to your
-`.emacs` file:
+<!-- markdown-toc start - Don't edit this section. Run M-x
markdown-toc-refresh-toc -->
+**Table of Contents**
-```lisp
-(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))
-```
+- [Installation via MELPA](#installation-via-melpa)
+- [Manual Installation](#manual-installation)
+- [rustfmt](#rustfmt)
+- [Tests](#tests)
+- [Other useful packages](#other-useful-packages)
-This associates `rust-mode` with `.rs` files. To enable it explicitly, do
-<kbd>M-x rust-mode</kbd>.
+<!-- markdown-toc end -->
-### `package.el` installation via MELPA
+# Installation via 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 MELPA, the community
-package source, yet, add this to `~/.emacs.d/init.el`:
+`rust-mode` makes editing [Rust](http://rust-lang.org) code with Emacs
+enjoyable. It requires Emacs 24 or later.
+The package is available on MELPA. Add this to your init.el.
-```lisp
+``` elisp
(require 'package)
(add-to-list 'package-archives
'("melpa" . "https://melpa.org/packages/") t)
(package-initialize)
+(package-refresh-contents)
```
-Then do this to load the package listing:
-
-* <kbd>M-x eval-buffer</kbd>
-* <kbd>M-x package-refresh-contents</kbd>
+Now you can install `rust-mode` with:
-#### MELPA stable
+`M-x package-install rust-mode`
-MELPA stable only updates when a new version tag is created. There isn't a
-specified frequency for this project to release versions; if you are a MELPA
-stable user and feel that the last release tag is too far out of date, open a
-pull request that updates the version header in `rust-mode.el` and note that a
-new version tag should be added when the request is merged.
-See [Pull Request #178](https://github.com/rust-lang/rust-mode/pull/178) (the
-first such pull request)) for an example of this.
+And put this in your config to load rust-mode automatically:
-#### Install `rust-mode`
+`(require 'rust-mode)`
-One you have `package.el`, you can install `rust-mode` or any other
-modes by choosing them from a list:
+# Manual Installation
-* <kbd>M-x package-list-packages</kbd>
+Add this to your init.el:
-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/`).
+``` elisp
+(add-to-list 'load-path "/path/to/rust-mode/")
+(autoload 'rust-mode "rust-mode" nil t)
+```
-* or using <kbd>M-x package-install rust-mode</kbd>
+# rustfmt
-### Package installation on Debian
+The `rust-format-buffer` function will format your code with
+[rustfmt](https://github.com/rust-lang/rustfmt) if installed. By default,
+this is bound to `C-c C-f`.
-```bash
-apt install elpa-rust-mode
-```
+Placing `(setq rust-format-on-save t)` in your init.el will enable automatic
+running of `rust-format-buffer` when you save a buffer.
-### Tests via ERT
+# Tests
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
you set the environment variable EMACS to a program that runs emacs.
-## Features
-
-### Formatting with [rustfmt][rfmt]
-
-The `rust-format-buffer` function will format your code with
-[rustfmt][rfmt] if installed. By default, this is bound to `C-c C-f`.
-
-Placing `(setq rust-format-on-save t)` in your `~/.emacs` will enable automatic
-running of `rust-format-buffer` when you save a buffer.
-
-[rfmt]: https://crates.io/crates/rustfmt/
-
-## License
-
-`rust-mode` is distributed under the terms of both the MIT license and the
-Apache License (Version 2.0).
+# Other useful packages
-See [LICENSE-MIT](LICENSE-MIT) and [LICENSE-APACHE](LICENSE-APACHE) for
details.
+[cargo.el](https://github.com/kwrooijen/cargo.el) Emacs Minor Mode for Cargo,
Rust's Package Manager
+[emacs-racer](https://github.com/racer-rust/emacs-racer) Racer support for
Emacs
+[rustic](https://github.com/brotzeit/rustic) Rust development environment for
Emacs
diff --git a/rust-mode.el b/rust-mode.el
index ec4f1c9..71e9458 100644
--- a/rust-mode.el
+++ b/rust-mode.el
@@ -1,6 +1,6 @@
;;; rust-mode.el --- A major emacs mode for editing Rust source code
-*-lexical-binding: t-*-
-;; Version: 0.4.0
+;; Version: 0.5.0
;; Author: Mozilla
;; Url: https://github.com/rust-lang/rust-mode
;; Keywords: languages
- [nongnu] elpa/rust-mode 1b3db88 422/486: Add a function wrap and unwrap with the dbg! macro., (continued)
- [nongnu] elpa/rust-mode 1b3db88 422/486: Add a function wrap and unwrap with the dbg! macro., ELPA Syncer, 2021/08/07
- [nongnu] elpa/rust-mode 8733792 448/486: Drop Emacs-24, ELPA Syncer, 2021/08/07
- [nongnu] elpa/rust-mode 9eb2c63 460/486: Fix README internal link (#389), ELPA Syncer, 2021/08/07
- [nongnu] elpa/rust-mode 13c4335 462/486: Improve doc-strings, ELPA Syncer, 2021/08/07
- [nongnu] elpa/rust-mode c23453d 463/486: rearrange I: Move options and faces to beginning of file, ELPA Syncer, 2021/08/07
- [nongnu] elpa/rust-mode 649f492 484/486: Create rust-cargo.el from existing code, ELPA Syncer, 2021/08/07
- [nongnu] elpa/rust-mode 198c777 386/486: Replaced font-lock-fontify-buffer with font-lock-ensure, ELPA Syncer, 2021/08/07
- [nongnu] elpa/rust-mode a871d10 390/486: Merge pull request #298 from jjwest/master, ELPA Syncer, 2021/08/07
- [nongnu] elpa/rust-mode 0a94268 396/486: Merge pull request #307 from Bunogi/master, ELPA Syncer, 2021/08/07
- [nongnu] elpa/rust-mode 86bc286 401/486: Add specific distribution for EVM, ELPA Syncer, 2021/08/07
- [nongnu] elpa/rust-mode 06b3b60 412/486: update readme (#327),
ELPA Syncer <=
- [nongnu] elpa/rust-mode c0cc6dc 420/486: Allow pass custom flags to rustfmt. (#338), ELPA Syncer, 2021/08/07
- [nongnu] elpa/rust-mode 888f3de 442/486: rust--format-fix-rustfmt-buffer: replace "stdin:" as well as "<stdin>:"., ELPA Syncer, 2021/08/07
- [nongnu] elpa/rust-mode ef152ad 459/486: Minor fixes (#388), ELPA Syncer, 2021/08/07
- [nongnu] elpa/rust-mode 0797e7b 017/486: add Url, ELPA Syncer, 2021/08/07
- [nongnu] elpa/rust-mode 5375e54 454/486: Test byte compilation of test code., ELPA Syncer, 2021/08/07
- [nongnu] elpa/rust-mode 33d178d 030/486: Make 'foo use font-lock-builtin-face, like module names, and make capitalized identifiers optionally use font-lock-type-face, ELPA Syncer, 2021/08/07
- [nongnu] elpa/rust-mode 9e2221c 034/486: Fix typo, ELPA Syncer, 2021/08/07
- [nongnu] elpa/rust-mode 8f926be 031/486: Emacs: Update emacs mode to be more similar to the vim mode., ELPA Syncer, 2021/08/07
- [nongnu] elpa/rust-mode cfb4408 354/486: Merge pull request #258 from sebastiencs/master, ELPA Syncer, 2021/08/07
- [nongnu] elpa/rust-mode b861aa9 358/486: Fixed indent when ? operator is used in chained method calls, ELPA Syncer, 2021/08/07