branch: externals/flymake-clippy
commit bb2fbe0971a7bc7f3a0c3dcec5dc0c07e5001934
Author: Michael Kirkland <michael.kirkland...@protonmail.com>
Commit: Michael Kirkland <mak.kirkl...@proton.me>
Update README.md
---
README.md | 46 ++++++++++++++++++++++++++++++++++++----------
1 file changed, 36 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index 567810c674..fce449d9cf 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,39 @@
-Flymake backend for Clippy, displaying lint diagnostics as overlays in the
buffer.
+# clippy-flymake
-Based on an
[example](https://www.gnu.org/software/emacs/manual/html_mono/flymake.html#An-annotated-example-backend)
provided in the official Flymake manual.
+`clippy-flymake` is an Emacs package that integrates
[Clippy](https://doc.rust-lang.org/clippy/), a linter for the Rust programming
language, with the Flymake diagnostics system. It provides real-time linting
feedback directly in your Emacs buffers using cargo clippy.
-Usage:
+## Features
-```elisp
-(use-package clippy-flymake
- :load-path "~/workspace/clippy-flymake"
- :hook ((rust-mode . clippy-flymake-setup))
- :config
- (add-hook 'rust-mode-hook #'flymake-mode))
-```
+- Runs `cargo clippy` automatically for Rust code.
+- Integrates with Emacs' Flymake for live linting feedback.
+- Displays Clippy diagnostics in the Emacs buffer.
+- Supports error, warning, and help messages with suggestions for fixing
issues.
+
+## Dependencies
+
+- Emacs 27 or later.
+- Rust with `cargo` and `clippy` installed.
+
+## Installation
+
+### Manual Installation
+
+1. Clone or download the repository to a local directory:
+
+ ```bash
+ git clone https://github.com/SiberzK/clippy-flymake.git
+ ```
+
+2. Add the following to your Emacs configuration:
+
+ ```elisp
+ (use-package clippy-flymake
+ :load-path "~/path/to/clippy-flymake"
+ :hook ((rust-mode . clippy-flymake-setup))
+ :custom (clippy-flymake-cargo-path "cargo") ; Optional: Specify the path
to the `cargo' executable.
+ :config (add-hook 'rust-mode-hook #'flymake-mode))
+ ```
+
+## License
+
+This package is free software and is distributed under the terms of the GNU
General Public License v3.0.
