aboutsummaryrefslogtreecommitdiffstats
path: root/README.org
diff options
context:
space:
mode:
authorBrian Cully <bjc@kublai.com>2021-02-21 10:54:54 -0500
committerBrian Cully <bjc@kublai.com>2021-02-21 10:54:54 -0500
commit63ef5484351e7fdf1bfa87b04f16be0dfee02007 (patch)
treeef6db8a972c2682e7b94001f1e5cc75ae019135a /README.org
downloadflymake-rust-63ef5484351e7fdf1bfa87b04f16be0dfee02007.tar.gz
flymake-rust-63ef5484351e7fdf1bfa87b04f16be0dfee02007.zip
Initial commit.
Diffstat (limited to 'README.org')
-rw-r--r--README.org20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..9b5a5aa
--- /dev/null
+++ b/README.org
@@ -0,0 +1,20 @@
+* Introduction
+=flymake-rust= adds support for the Rust programming language to Emacs’
+built-in Flymake system.
+
+* Installation
+This package is not yet available on the various package sites
+
+** Direct download
+Download this repository to some location, then add the following to
+your Emacs initialization:
+#+begin_src emacs-lisp
+ (add-to-list 'load-path "/path/to/flymake-rust")
+ (require flymake-rust)
+#+end_src
+
+* Usage
+Add the setup hook for =rust-mode=
+#+begin_src emacs-lisp
+ (add-hook 'rust-mode-hook 'flymake-rust-setup)
+#+end_src