[nongnu] elpa/j-mode 140c2b6 12/56: Updated README and cleaned up docs a bit

[ELPA Syncer]

branch: elpa/j-mode
commit 140c2b6319232ef01dc89ee6452379f11038374d
Author: Zachary Elliott <zach@nyu.edu>
Commit: Zachary Elliott <zach@nyu.edu>

    Updated README and cleaned up docs a bit
---
 README.md      | 64 ++++++++++++++++++++++++++++++----------------------------
 j-font-lock.el | 32 -----------------------------
 j-help.el      |  2 +-
 j-mode.el      |  6 +++---
 4 files changed, 37 insertions(+), 67 deletions(-)

diff --git a/README.md b/README.md
index dbf31a0..d6ce00a 100644
--- a/README.md
+++ b/README.md
@@ -1,26 +1,26 @@
 
 # J Mode
 
-Provides font-lock and basic REPL integration for the
-[J programming language](http://www.jsoftware.com)
+Provides font-lock, REPL integration ( via comint ) and a basic help
+documentation for the [J programming language](http://www.jsoftware.com).
 
 ## Installation
 
-The only method of installation is to check out the project, add it
-to the load path, and load normally. This may change one day.
+Currently the method of installation is entirely manually. Fetch the source via
+git or direct download, place in your load path and load / require normally.
 
 ```lisp
-;; Put this in your emacs config
+;; Add this to your emacs config
 (add-to-list 'load-path "/path/to/j-mode/")
-(load "j-mode")
+(autoload 'j-mode "j-mode.el" "Major mode for editing J files" t)
 ```
 
-## font-lock Configuration
+## J Font Lock
 
-j-mode relies on four newly introduced faces to help colour the various parts 
of
-speech. Those faces are `j-verb-face` `j-adverb-face` `j-conjunction-face`
-`j-other-face`. They can be changed like any other face to help bring them in
-line with what ever your display configuration is.
+`j-mode` font-lock provides four new faces for management of the coloring
+various parts of speech. Those faces are `j-verb-face` `j-adverb-face`
+`j-conjunction-face` `j-other-face`. They can be modified like any of the
+standard built in faces to help meet your need.
 
 ```lisp
 (custom-set-face
@@ -30,34 +30,36 @@ line with what ever your display configuration is.
  '(j-other-face ((t (:foreground "Black")))))
 ```
 
-If you are not interested in coloring the various parts of speech you can also
-just set all of the faces to be the same.
+## J Console
 
-```lisp
-(let ((default-color "Black"))
-  (custom-set-face
-   '(j-verb-face ((t (:foreground default-color :background "Clear"))))
-   '(j-adverb-face ((t (:foreground default-color :background "Clear"))))
-   '(j-conjunction-face ((t (:foreground default-color :background "Clear"))))
-   '(j-other-face ((t (:foreground default-color :background "Clear"))))))
-```
+Interaction to the j REPL is provided via the comint module. The `j-console`
+function starts the REPL session in a new buffer.
 
-## REPL Interaction
+The module provides the following key bindings for convenience
 
-Interaction is rudimentary. <kbd>M-x j-console</kbd> or <kbd>C-c !</kbd> in
-`j-mode` will start a new jconsole process wrapped in a comint buffer.
+* <kbd>C-c !</kbd> Runs the `j-console` function
+* <kbd>C-c C-l</kbd> Executes the current line
+* <kbd>C-c C-r</kbd> Executes the current region
+* <kbd>C-c C-c</kbd> Executes the current buffer
 
-The following commands are provided as convenience methods
+## J Help
 
-- <kbd>C-c C-l</kbd> Executes the current line
-- <kbd>C-c C-r</kbd> Executes the current region
-- <kbd>C-c C-c</kbd> Executes the current buffer
+`j-help` provides access to the
+[J software vocabulary](http://www.jsoftware.com/help/dictionary/vocabul.htm)
+via two functions `j-help-lookup-symbol` and
+`j-help-lookup-symbol-at-point`. `j-help-look-symbol` takes one string argument
+( generally via the mini-buffer ) which it then looks up.
+`j-help-lookup-symbol-at-point` attempts to determine which symbol is under 
your
+cursor and then passes that to `j-help-lookup-symbol-at-point`.
 
-All of them will start a jconsole session if there isn't one already running.
+The module provides the following key bindings for convenience
 
+* <kbd>C-c h</kbd> runs `j-help-lookup-symbol`
+* <kbd>C-c C-h</kbd> `j-help-lookup-symbol-at-point`
 
-## License
+### License
 
 Copyright (C) 2012 Zachary Elliott
 
-Distributed under the GNU General Public License; see <kbd>C-h t</kbd> in 
emacs to view.
+Distributed under the GNU General Public License; see <kbd>C-h t</kbd> in emacs
+to view.
diff --git a/j-font-lock.el b/j-font-lock.el
index 1173195..30c16a4 100644
--- a/j-font-lock.el
+++ b/j-font-lock.el
@@ -42,7 +42,6 @@
   :group 'j
   :prefix "j-font-lock-")
 
-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 (defgroup j-faces nil
   "Faces for j-mode font-lock"
   :group 'j-)
@@ -79,7 +78,6 @@
   `((t (:foreground "Black")))
   "Font Lock mode face used to higlight others"
   :group 'j-faces))
-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 
 (defvar j-font-lock-syntax-table
   (let ((table (make-syntax-table)))
@@ -191,33 +189,3 @@ this in emacs and it poses problems"
            font-lock-comment-face))))
 
 (provide 'j-font-lock)
-
-;;;;;###autoload
-;;(defun j-mode ()
-;;  "Major mode for editing J code"
-;;  (interactive)
-;;  (kill-all-local-variables)
-;;  (use-local-map j-mode-map)
-;;  (setq mode-name "J"
-;;        major-mode 'j-mode)
-;;  (set-syntax-table j-mode-syntax-table)
-;;  (set (make-local-variable 'comment-start)
-;;       "NB.")
-;;  (set (make-local-variable 'comment-start-skip)
-;;       "\\(\\(^\\|[^\\\\\n]\\)\\(\\\\\\\\\\)*\\)NB. *")
-;;  (set (make-local-variable 'font-lock-comment-start-skip)
-;;       "NB. *")
-;;  (set (make-local-variable 'font-lock-defaults)
-;;       '(j-mode-font-lock-keywords
-;;         nil nil nil nil
-;;;;         (font-lock-mark-block-function . mark-defun)
-;;         (font-lock-syntactic-face-function
-;;          . j-font-lock-syntactic-face-function)))
-;;  (run-mode-hooks 'j-mode-hook))
-;;
-;;;;;###autoload
-;;(progn
-;;  (add-to-list 'auto-mode-alist '("\\.ij[rstp]$" . j-mode)))
-;;
-;;(provide 'j-mode '(j-console))
-;;
diff --git a/j-help.el b/j-help.el
index b4e9bf0..6ef9ba9 100644
--- a/j-help.el
+++ b/j-help.el
@@ -12,7 +12,7 @@
 
 ;;; Commentary:
 
-;; This is not complete
+;;
 
 ;;; License:
 
diff --git a/j-mode.el b/j-mode.el
index cbc41f0..4596e93 100644
--- a/j-mode.el
+++ b/j-mode.el
@@ -12,8 +12,7 @@
 
 ;;; Commentary:
 
-;; Provides font-lock and basic REPL integration for the J programming language
-;; (http://www.jsoftware.com)
+;;
 
 ;;; License:
 
@@ -34,9 +33,10 @@
 
 ;;; Code:
 
+(require 'j-font-lock)
 (require 'j-console)
 (require 'j-help)
-(require 'j-font-lock)
+
 
 (defconst j-mode-version "0.1.0"
   "`j-mode' version")