diff options
| -rw-r--r-- | README.org | 84 | ||||
| -rw-r--r-- | trident-mode.el | 82 |
2 files changed, 86 insertions, 80 deletions
@@ -10,21 +10,26 @@ the time of writing it's unclear whether it's still being actively developed. ** Installation -Trident has both [[http://en.wikipedia.org/wiki/Common_Lisp][Common Lisp]] and Emacs dependencies. +Trident is available on [[http://melpa.milkbox.net/][MELPA]], meaning a simple =M-x package-install RET +trident-mode RET= will install both it and its dependencies. -- Common Lisp dependencies - - Your preferred [[http://en.wikipedia.org/wiki/Common_Lisp][Common Lisp]] implementation - - [[http://common-lisp.net/project/parenscript/][Parenscript]] +To enable MELPA, if you haven't already, add something like the following to +your Emacs configuration: -You almost certainly want to use [[http://www.quicklisp.org/beta/][Quicklisp]] to install Parenscript. +#+BEGIN_SRC emacs-lisp + (require 'package) + (add-to-list 'package-archives + '("melpa" . "http://melpa.milkbox.net/packages/") t) + (package-initialize) +#+END_SRC -- Emacs dependencies +The dependencies that will be installed are: - [[http://common-lisp.net/project/slime/][SLIME]] - [[https://github.com/skeeto/skewer-mode][Skewer]] - [[https://github.com/magnars/dash.el][dash.el]] -My recommendation is to install SLIME via the [[https://github.com/quicklisp/quicklisp-slime-helper][Quicklisp SLIME Helper]] and -the others through [[http://www.emacswiki.org/emacs/ELPA][ELPA]]. +Trident also requires a [[http://en.wikipedia.org/wiki/Common_Lisp][Common Lisp]] implementation and Parenscript. [[http://www.quicklisp.org/beta/][Quicklisp]] +is the best way to install Parenscript. ** Setup @@ -68,12 +73,12 @@ open a JavaScript REPL you can run =M-x skewer-repl=. These commands generate JavaScript from the Parenscript code and display it but don't send it to the browser for evaluation: - - =trident-expand-sexp= - - =trident-expand-last-expression= - - =trident-expand-defun= - - =trident-expand-region= - - =trident-expand-buffer= - - =trident-expand-dwim= + - =trident-expand-sexp= + - =trident-expand-last-expression= + - =trident-expand-defun= + - =trident-expand-region= + - =trident-expand-buffer= + - =trident-expand-dwim= From within an expansion buffer you can press =e= to send the JavaScript to the browser, =w= to copy it to the kill ring, =s= to save it to a file (you'll be @@ -88,12 +93,12 @@ current buffer and save the generated code directly to a file. These commands first compile the Parenscript code to JavaScript and then immediately send to it the browser to be evaluated: - - =trident-eval-sexp= - - =trident-eval-last-expression= - - =trident-eval-defun= - - =trident-eval-region= - - =trident-eval-buffer= - - =trident-eval-dwim= + - =trident-eval-sexp= + - =trident-eval-last-expression= + - =trident-eval-defun= + - =trident-eval-region= + - =trident-eval-buffer= + - =trident-eval-dwim= ** Key bindings @@ -114,18 +119,18 @@ For example: The full list of key bindings =trident-add-keys-with-prefix= will establish is: - - =e RET= -- =trident-eval-sexp= - - =e e= -- =trident-eval-last-expression= - - =e d= -- =trident-eval-defun= - - =e r= -- =trident-eval-region= - - =e b= -- =trident-eval-buffer= - - =e SPC= -- =trident-eval-dwim= - - =x RET= -- =trident-expand-sexp= - - =x e= -- =trident-expand-last-expression= - - =x d= -- =trident-expand-defun= - - =x r= -- =trident-expand-region= - - =x b= -- =trident-expand-buffer= - - =x SPC= -- =trident-expand-dwim= + - =e RET= -- =trident-eval-sexp= + - =e e= -- =trident-eval-last-expression= + - =e d= -- =trident-eval-defun= + - =e r= -- =trident-eval-region= + - =e b= -- =trident-eval-buffer= + - =e SPC= -- =trident-eval-dwim= + - =x RET= -- =trident-expand-sexp= + - =x e= -- =trident-expand-last-expression= + - =x d= -- =trident-expand-defun= + - =x r= -- =trident-expand-region= + - =x b= -- =trident-expand-buffer= + - =x SPC= -- =trident-expand-dwim= Evaluation commands begin with an "e", expansion commands with "x". The second letter is generally mnemonic but not always. The =-sexp= commands use =RET= in @@ -172,14 +177,13 @@ straight there. ** Still do be done - - Test against a wider array of code. Are there problems with quoting? - - Better documentation. - - Look into adding a REPL. - - See if more integration with SLIME is possible. - - Command(s) for compiling to a file. - - Similar support for [[http://weitz.de/cl-who/][CL-WHO]] and/or [[https://github.com/paddymul/css-lite][CSS-LITE]]? - - Get to know ELPA and packaging. - - Add support for Customize. + - Add some tests. + - Better documentation. + - Look into adding a REPL. + - See if more integration with SLIME is possible. + - Command(s) for compiling to a file. + - Similar support for [[http://weitz.de/cl-who/][CL-WHO]] and/or [[https://github.com/paddymul/css-lite][CSS-LITE]]? + - Add support for Customize. ** Contributing diff --git a/trident-mode.el b/trident-mode.el index 39ad665..639db0c 100644 --- a/trident-mode.el +++ b/trident-mode.el @@ -17,21 +17,24 @@ ;; ** Installation -;; Trident has both Common Lisp and Emacs dependencies. +;; Trident is available on MELPA, meaning a simple =M-x package-install RET +;; trident-mode RET= will install both it and its dependencies. -;; - Common Lisp dependencies -;; - Your preferred Common Lisp implementation -;; - Parenscript +;; To enable MELPA, if you haven't already, add something like the following to +;; your Emacs configuration: -;; You almost certainly want to use Quicklisp to install Parenscript. +;; (require 'package) +;; (add-to-list 'package-archives +;; '("melpa" . "http://melpa.milkbox.net/packages/") t) +;; (package-initialize) -;; - Emacs dependencies +;; The dependencies that will be installed are: ;; - SLIME ;; - Skewer ;; - dash.el -;; My recommendation is to install SLIME via the Quicklisp SLIME Helper and the -;; others, including Trident itself, through Emacs's package.el infrastructure. +;; Trident also requires a Common Lisp implementation and Parenscript. +;; Quicklisp is the best way to install Parenscript. ;; ** Setup @@ -71,12 +74,12 @@ ;; These commands generate JavaScript from the Parenscript code and display it ;; but don't send it to the browser for evaluation: -;; - trident-expand-sexp -;; - trident-expand-last-expression -;; - trident-expand-defun -;; - trident-expand-region -;; - trident-expand-buffer -;; - trident-expand-dwim +;; - trident-expand-sexp +;; - trident-expand-last-expression +;; - trident-expand-defun +;; - trident-expand-region +;; - trident-expand-buffer +;; - trident-expand-dwim ;; From within an expansion buffer you can press e to send the JavaScript to ;; the browser, w to copy it to the kill ring, s to save it to a file (you'll @@ -92,12 +95,12 @@ ;; These commands first compile the Parenscript code to JavaScript and then ;; immediately send to it the browser to be evaluated: -;; - trident-eval-sexp -;; - trident-eval-last-expression -;; - trident-eval-defun -;; - trident-eval-region -;; - trident-eval-buffer -;; - trident-eval-dwim +;; - trident-eval-sexp +;; - trident-eval-last-expression +;; - trident-eval-defun +;; - trident-eval-region +;; - trident-eval-buffer +;; - trident-eval-dwim ;; ** Key bindings @@ -114,18 +117,18 @@ ;; The full list of key bindings trident-add-keys-with-prefix will establish ;; is: -;; - "e RET" -- trident-eval-sexp -;; - "e e" -- trident-eval-last-expression -;; - "e d" -- trident-eval-defun -;; - "e r" -- trident-eval-region -;; - "e b" -- trident-eval-buffer -;; - "e SPC" -- trident-eval-dwim -;; - "x RET" -- trident-expand-sexp -;; - "x e" -- trident-expand-last-expression -;; - "x d" -- trident-expand-defun -;; - "x r" -- trident-expand-region -;; - "x b" -- trident-expand-buffer -;; - "x SPC" -- trident-expand-dwim +;; - "e RET" -- trident-eval-sexp +;; - "e e" -- trident-eval-last-expression +;; - "e d" -- trident-eval-defun +;; - "e r" -- trident-eval-region +;; - "e b" -- trident-eval-buffer +;; - "e SPC" -- trident-eval-dwim +;; - "x RET" -- trident-expand-sexp +;; - "x e" -- trident-expand-last-expression +;; - "x d" -- trident-expand-defun +;; - "x r" -- trident-expand-region +;; - "x b" -- trident-expand-buffer +;; - "x SPC" -- trident-expand-dwim ;; Evaluation commands begin with an "e", expansion commands with "x". The ;; second letter is generally mnemonic but not always. The -sexp commands use @@ -170,14 +173,13 @@ ;; ** Still do be done -;; - Test against a wider array of code. Are there problems with quoting? -;; - Better documentation. -;; - Look into adding a REPL. -;; - See if more integration with SLIME is possible. -;; - Command(s) for compiling to a file. -;; - Similar support for CL-WHO and/or CSS-LITE? -;; - Get to know ELPA and packaging. -;; - Add support for Customize. +;; - Add some tests. +;; - Better documentation. +;; - Look into adding a REPL. +;; - See if more integration with SLIME is possible. +;; - Command(s) for compiling to a file. +;; - Similar support for CL-WHO and/or CSS-LITE? +;; - Add support for Customize. ;; ** Contributing |