[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/lua-mode c0d6f80 079/468: Add markdown README
From: |
Philip Kaludercic |
Subject: |
[nongnu] elpa/lua-mode c0d6f80 079/468: Add markdown README |
Date: |
Thu, 5 Aug 2021 04:58:11 -0400 (EDT) |
branch: elpa/lua-mode
commit c0d6f80f734ddee5e787314b082d89942437710f
Author: immerrr <immerrr@gmail.com>
Commit: immerrr <immerrr@gmail.com>
Add markdown README
---
README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 44 insertions(+)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3dc9bd2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+# 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.
+
+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).
+
+## INSTALLATION
+
+To install, just copy `lua-mode.el` into a directory on your load-path (and
optionally byte-compile it).
+To set up Emacs to automatically edit files ending in `.lua` or with a lua
hash-bang line using **lua-mode**
+add the following to your init file:
+
+ (autoload 'lua-mode "lua-mode" "Lua editing mode." t)
+ (add-to-list 'auto-mode-alist '("\\.lua$" . lua-mode))
+ (add-to-list 'interpreter-mode-alist '("lua" . lua-mode))
+
+## USAGE
+
+**lua-mode** supports c-mode style 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:
+
+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
+
+## 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.
+
+### 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.
+
+### 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.
- [nongnu] elpa/lua-mode cc46763 061/468: Add some comments, (continued)
- [nongnu] elpa/lua-mode cc46763 061/468: Add some comments, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode b2860f1 062/468: lua-setup-keymap: improve readability, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode 7935b5f 064/468: Fix previous commit, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode 85d26f8 065/468: lua-mode-map: initialize as soon as lua-mode is loaded (previously waited for call to lua-mode), Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode 3339da6 067/468: lua-prefix-key: auto-convert from/to character, update bindings automagically, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode 5842703 068/468: Add TODO, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode 8165775 069/468: Fix lua-set-prefix message, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode 6b1d389 074/468: lua-calculate-unindentation: skip semicolons as well, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode bda4fbd 075/468: lua-calculate-unindentation: update docs, remove extraneous catch, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode a20b08e 078/468: lua-indent-line: remove extra variable shift-amt, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode c0d6f80 079/468: Add markdown README,
Philip Kaludercic <=
- [nongnu] elpa/lua-mode 08cff6e 081/468: Implement basic multiline-aware functionality, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode dfc3b78 083/468: Preserve buffer-modified-p state when (un-)marking multiline delimiters, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode 7920d17 087/468: lua-mark-all-multiline-literals: if region is active, limit to region boundaries, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode 4a22b3c 100/468: Allow lua-start-process to be called interactively., Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode a3ed448 106/468: Make dist with git-archive, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode 742180e 125/468: lua-automark-multiline: add lua-automark-multiline-maxsize variable to prevent long waits on big files, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode 0b3df35 135/468: Fix string content indentation: it's now indented by indent-level relative to indentation of the line where string/comment literal starts (issue #6), Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode 5aa6f9e 042/468: Patch from Reuben: fix long string colouring problem, Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode eb5d301 055/468: Bump version., Philip Kaludercic, 2021/08/05
- [nongnu] elpa/lua-mode d66ec8e 080/468: Remove broken multiline literal font-locking, Philip Kaludercic, 2021/08/05