X-Git-Url: https://code.delx.au/gnu-emacs-elpa/blobdiff_plain/52241c5544294964b9e9d2f0b61ace82384779a4..92f5479d9bc27b5289d352946a76ef585525a22e:/README.md diff --git a/README.md b/README.md index a8f5ac8ec..cbce9c37c 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,55 @@ -Description +About [![Build Status](https://travis-ci.org/mooz/js2-mode.svg?branch=master)](https://travis-ci.org/mooz/js2-mode) [![MELPA](https://melpa.org/packages/js2-mode-badge.svg)](https://melpa.org/#/js2-mode) ====== -An improved JavaScript mode for GNU Emacs. Forked from . +Improved JavaScript editing mode for GNU Emacs ([description here](http://elpa.gnu.org/packages/js2-mode.html)). -For some of the user-visible changes, see -[Changes from the original mode](https://github.com/mooz/js2-mode/wiki/Changes-from-the-original-mode). +For some of the latest changes, see [latest user-visible changes](https://github.com/mooz/js2-mode/wiki/Latest-user-visible-changes). Installation ====== - $ git clone git://github.com/mooz/js2-mode.git - $ cd js2-mode - $ git checkout emacs24 - $ emacs --batch -f batch-byte-compile js2-mode.el +The stable versions are hosted at [GNU ELPA](http://elpa.gnu.org/) +(M-x list-packages). -Then put js2-mode.elc into your site-lisp directory. - -In your emacs config: - - (autoload 'js2-mode "js2-mode" nil t) - (add-to-list 'auto-mode-alist '("\\.js$" . js2-mode)) - -See for -additional details. +You can also install the latest development version from +[MELPA](https://melpa.org/#/getting-started). Emacs 22 and 23 =============== -This version requires Emacs 24. For backwards-compatible version, check out the [`master` branch](https://github.com/mooz/js2-mode/tree/master). +This version requires Emacs 24 and `cl-lib` (either built-in or from GNU ELPA above). +For a backward compatible version, check out the branch +[emacs23](https://github.com/mooz/js2-mode/tree/emacs23). Bugs ==== -If you find problems, please report them at . +* See broken syntax highlighting and timer errors? Recently upgraded +Emacs from version 24.2 or earlier? + +* Try +[reinstalling or byte-recompiling](https://github.com/mooz/js2-mode/issues/72) +the package. + +Please report problems at . + +Contributing +====== + +`js2-mode` is subject to the same +[copyright assignment](http://www.gnu.org/prep/maintain/html_node/Copyright-Papers.html) +policy as Emacs itself, `org-mode`, `CEDET` and other packages in +[GNU ELPA](http://elpa.gnu.org/packages/). + +Any +[legally significant](http://www.gnu.org/prep/maintain/html_node/Legally-Significant.html#Legally-Significant) +contributions can only be accepted after the author has completed their +paperwork. Please ask for the request form, and we'll send it to you. See Also ====== Some third-party modes that use the generated syntax tree: -* [js2-highlight-vars-mode](http://mihai.bazon.net/projects/editing-javascript-with-emacs-js2-mode/js2-highlight-vars-mode) * [js2-refactor](https://github.com/magnars/js2-refactor.el) +* [skewer-mode](https://github.com/skeeto/skewer-mode)