branch: elpa/dart-mode
commit bf82220ff3520878be562b00edb12b71702cf0c3
Merge: c54f014 e05c132
Author: Natalie Weizenbaum <[email protected]>
Commit: Natalie Weizenbaum <[email protected]>
Merge pull request #19 from tonygentilcore/readme
Add a README.md with installation instructions.
---
README.md | 22 ++++++++++++++++++++++
dart-mode.el | 5 +----
2 files changed, 23 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2812ed7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+Dart Mode
+=========
+Dart Mode is a major mode for editing Dart files in Emacs.
+
+## Installation
+
+1. Add both [MELPA](http://melpa.org/#/getting-started) and
+ [Marmalade](https://marmalade-repo.org/#download) to your
+ `package-archives` if you don't already have them.
+
+1. Install dart-mode via:
+ ```
+ M-x package-refresh-contents [RET]
+ M-x package-install [RET] dart-mode
+ ```
+
+1. OPTIONAL: To enable on-the-fly syntax checking, add the
+ following to your `.emacs` file:
+ ```
+ (setq dart-enable-analysis-server t)
+ (add-hook 'dart-mode-hook 'flycheck-mode)
+ ```
diff --git a/dart-mode.el b/dart-mode.el
index 684fd1a..8306914 100644
--- a/dart-mode.el
+++ b/dart-mode.el
@@ -23,10 +23,7 @@
;;; Commentary:
-;; To install, save this on your load path and add the following to
-;; your .emacs file:
-;;
-;; (require 'dart-mode)
+;; To install, see https://github.com/nex3/dart-mode/blob/master/README.md
;;
;; Known bugs:
;;
