[nongnu] elpa/lua-mode 28155ba 241/468: Update README.md

[Philip Kaludercic]

branch: elpa/lua-mode
commit 28155ba25b3ca6e5a4386500473f89f0a8aca62d
Author: immerrr <immerrr@gmail.com>
Commit: immerrr <immerrr@gmail.com>

    Update README.md
---
 README.md | 39 +++++++++++++++------------------------
 1 file changed, 15 insertions(+), 24 deletions(-)

diff --git a/README.md b/README.md
index 9b2d6ef..a682f7b 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,7 @@
 # Lua mode
 
-**lua-mode** is a major mode for editing Lua sources in Emacs. After a rather 
long hiatus, it's back in active development stage, so make sure to visit 
[homepage](https://github.com/immerrr/lua-mode) frequently enough.
+**lua-mode** is a major mode for editing Lua sources in Emacs.
+
 
 If you have a problem or a suggestion about **lua-mode**, please, let me know 
about it via github's [Issue 
Tracker](https://github.com/immerrr/lua-mode/issues).
 
@@ -35,31 +36,21 @@ hash-bang line (`#!/usr/bin/lua`). Putting this snippet to 
`.emacs` should be en
     (add-to-list 'auto-mode-alist '("\\.lua$" . lua-mode))
     (add-to-list 'interpreter-mode-alist '("lua" . lua-mode))
 ```
-## USAGE
-
-**lua-mode** supports some formatting and sending of lines/regions/files to a 
Lua interpreter. An
-interpreter (see variable `lua-default-application`) will be started if you 
try to send some code and none
-is running. You can use the process-buffer (named after the application you 
chose) as if it were an
-interactive shell. See the documentation for `comint.el` for details.
-
-Lua-mode also works with Hide Show minor mode (see ``hs-minor-mode``).
 
-## TODO
-Currently, there're a lot of features that need fixing (or reimplementing), 
including but not limited to:
+## FEATURES
 
-1. implementing autotesting of indentation engine
-1. supporting line-continuation commas
-1. fixing close-brace/paren positioning
-1. fix syntax handling of multiline comments/literals (including both 
highlighting & indentation)
-1. implementing a crisp scheme of customizing the way lua-mode indents the code
-1. cleaning up existing code
-1. extending docs & comments
+- syntactic indentation & highlighting (including multiline literals/comments)
+- evaluation of lines/regions/functions/files in Lua subprocess or direct 
interaction with its REPL
+- documentation lookup (using online/offline reference manual, e.g. 
[string.find](http://www.lua.org/manual/5.1/manual.html#pdf-string.find))
+- [imenu](http://www.gnu.org/software/emacs/manual/html_node/emacs/Imenu.html) 
integration
+- 
[HideShow](http://www.gnu.org/software/emacs/manual/html_node/emacs/Hideshow.html)
 integration
 
-## CEDET/Semantic integration
-Also, there's a rather distant goal to integrate lua-mode with [cedet's 
semantic](http://cedet.sourceforge.net/semantic.shtml). This would mean an 
almost complete rewrite, but I think the challenge is worth it. There's a 
slightest concern about the overhead brought by this dependency, but 
**semantic** is already being shipped with Emacs, so there might be no problem 
after all.
+## CUSTOMIZATION
 
-### Use wisent-generated grammar
-First stage would be to rewrite syntax handling with help of 
**semantic/wisent**-generated parser based on the actual Lua grammar. 
Currently, syntax analysis is done ad-hoc and, despite the model is 
oversimplified and doesn't treat corner situation well, it's still very tricky 
and really hard to grasp.
+The following variables are available for customization (see more via `M-x 
customize-group lua`):
 
-### Extend cedet/semantic facilities onto Lua
-And there's the cherry on the pie: after completing the wisent-generated 
parser, the next step will be to provide semantic with all the information it 
needs to do it's magic of code analysis and generation.
+- `lua-indent-level` (default `3`): indentation offset in spaces
+- `lua-default-application` (default `"lua"`): command to start up the 
interpreter
+- `lua-default-command-switches` (default `"-i"`): arguments to pass to the 
interpreter on startup (make sure `-i` is there if you expect working with REPL)
+- `lua-search-url-prefix` (default 
`"http://www.lua.org/manual/5.1/manual.html#pdf-"`): base URL for documentation 
lookup
+- `lua-indent-string-contents` (default `nil`): set to `t` if you like to have 
contents of multiline strings to be indented like comments