branch: elpa/lua-mode
commit d128a743533c86650fc5abaa0a58a67ddf183d45
Author: immerrr <[email protected]>
Commit: immerrr <[email protected]>
Add initial version of test/indentation/README.md
---
test/indentation/README.md | 16 ++++++++++++++++
1 file changed, 16 insertions(+)
diff --git a/test/indentation/README.md b/test/indentation/README.md
new file mode 100644
index 0000000..532eca1
--- /dev/null
+++ b/test/indentation/README.md
@@ -0,0 +1,16 @@
+This directory contains files used to test lua-mode indentation engine. Test
+input is stored in `*.lua` files which are compared to their respective etalon
+files `*.lua.etalon`.
+
+To run all tests, do
+```
+$ ./test_indentation.sh *.lua
+```
+
+Feel free to add your own tricky cases, if you don't see them here, no specific
+guidelines here, just try to bundle them logically into several bigger files.
+
+Additional lua-mode customization may be performed on a file basis with the use
+of [emacs file variables].
+
+[emacs file variables]:
http://www.gnu.org/software/emacs/manual/html_node/emacs/File-Variables.html
