Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 8aee621

Browse files
author
Polite Kiwi
authoredDec 31, 2017
Update README.md
1 parent 822c297 commit 8aee621

File tree

1 file changed

+35
-16
lines changed

1 file changed

+35
-16
lines changed
 

‎README.md

Lines changed: 35 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,47 @@ A simple, powerful lua console with the intent of replacing CMD and Terminal + L
44

55
### TODO
66
* Move additions to separate global table 'add'
7-
* Triple check buffer overflows and mem alignment and memleaks
8-
* Add `-l string` option to allow dll's to be loaded easier
7+
* Triple check buffer overflows and mem alignment and memleaks, as well as iffy -1 versus 1 when using lua_*
98

109
# About
11-
12-
Lua Console | Version: 9/26/2017
10+
luaw -?
11+
```
12+
Lua Console | Version: 12/31/2017
1313
Lua 5.3.4 Copyright (C) 1994-2017 Lua.org, PUC-Rio
1414
LuaConsole Copyright MIT (C) 2017 Hydroque
1515
16-
- Line by Line interpretation
17-
- Files executed by passing argument
18-
- Working directory support addition
19-
- Built in stack-dump addition
20-
- Console clear addition
21-
- Supports Lua5.3, Lua5.2, Lua5.1
16+
Supports Lua5.3, Lua5.2, Lua5.1
17+
5.2.x and 5.1.x assume that you have enough memory for initial functions.
18+
19+
- Line by Line interpretation
20+
- Files executed by passing
21+
- Global variable defintions
22+
- Dynamic module loading
23+
- Working directory support
24+
- Built in stack-dump
25+
- Console clearing
26+
27+
Usage: lua.exe [FILE_PATH] [-v] [-e] [-s START_PATH] [-p] [-a] [-c] [-Dvar=val]
28+
[-Lfilepath.lua] [-b] [-?] [-n]{parameter1 ...}
29+
30+
-v Prints the Lua version in use
31+
-e Prevents lua core libraries from loading
32+
-s Issues a new root path
33+
-p Has console post exist after script in line by line mode
34+
-a Disables the additions
35+
-c No copyright on init
36+
-d Defines a global variable as value after '='
37+
-l Executes a module before specified script or post-exist
38+
-b Load specified parameters by -n before -l modules execute
39+
-n Start of parameter section
40+
-? Displays this help message
41+
```
2242

23-
A console whose code is much easier to look at and handle than the one provided native with Lua. Supports everything Lua's console does except multiline support. Runs compiled source without a problem. Use -? to get a list of the switches. Should work on linux as well as mac and windows. If it doesn't make a pull request and/or start an issue.
43+
A console whose code is much easier to look at and handle than the one provided native with Lua. Has more functionality with native lua console. Supports everything Lua's console does except multiline support in-post-exist. Runs compiled source without a problem. Use -? to get a list of the switches above (different depending on how you build it). Works on Linux, Windows, and Mac. Support for LuaRocks is in the wiki. Want to contribute? Submit a pull request. Want to report a bug? Start an issue. Ideas? Start an issue.
2444

2545
# Additions
2646

27-
There is an 'additions' module to this interpretor, which is completely up to the user to utilize. You can temporarily disable them with the -a switch, or even keep them out of your build. Doing so will take away the added `os.getcwd()` and `os.setcwd(string)` and `stackdump(...)` and `os.clear()` functions, which let you set the current working directory and view your stack. A clear function also has been added, which should uses the nasty system() call as well as use clear (cls only on windows). Lua Console acts much like a console now that the additions were added.
47+
There is an 'additions' module to this interpreter, which is completely up to the user to utilize. You can temporarily disable them with the -a switch, or even keep them out of your build. Doing so will take away the added `os.getcwd()` and `os.setcwd(string)` and `stackdump(...)` and `os.clear()` functions, which let you set the current working directory and view your stack. A clear function also has been added, which uses the nasty system() call as well as use clear (cls only on windows). Lua Console acts much like a console now that the additions were added.
2848

2949
stackdump() is a global function. It works as easy as print does, but it does type conversion from lua to C-string and lists anything left in the stack.
3050

@@ -39,7 +59,6 @@ For example, <br>
3959
4060
This sure beats `print(type(data), data)` calls, and can be used to detect anything left on the stack in C. To add your own C functions, inherit the project and modify the additions.c file only. Another method to adding C functions is creating a similar dll file:
4161
```
42-
4362
#include <stdio.h>
4463
#include "lua.h"
4564
@@ -52,7 +71,7 @@ LUA_DLL_EXPORT luaopen_testdll(lua_State *L) {
5271
return 0;
5372
}
5473
```
55-
This is how LuaRocks does it, but they have file formats and containers. Everything LuaRocks compiles down to a dll or two, gets loaded, then taken over by whatever lua script loaded it. Then just compile and run load it in lua:
74+
This is how LuaRocks does it, but they have file formats and containers. Everything LuaRocks compiles down to a dll or two, gets loaded, then taken over by whatever lua script loaded it. Then just compile and run it in lua:
5675
```
5776
gcc -g0 -O2 -Wall -c testdll.c
5877
gcc -g0 -O2 -Wall -shared -o testdll.dll testdll.o
@@ -63,11 +82,11 @@ print(testdll) -> function
6382
testdll() -> Loaded successfully!
6483
```
6584

66-
Added very comprehensive error feedback, which tells you about the stack (stack dumps, too, if not just the error is on the stack), the type of error (syntax/runtime), and the regular lua feedback string with the line number sammich'd between two colons.
85+
Added very comprehensive error feedback, which tells you about the stack (stack dumps, too, if not just the error is on the stack), the type of error (syntax/runtime), and the regular lua feedback string with the line number sammich'd between two colons. Now with file name!
6786

6887
For example, <br>
6988
>\>. <br>
70-
>(Syntax) | Stack Top: 1 | [string "."]:1: unexpected symbol near '.' <br>
89+
>(Syntax) | Stack Top: 1 | Example_Error.lua | [string "."]:1: unexpected symbol near '.' <br>
7190
7291
# Using with LuaRocks
7392
[Windows MinGW](https://github.com/Hydroque/LuaConsole/wiki/LuaRocks-Support-Windows-MinGW)

0 commit comments

Comments
 (0)
Please sign in to comment.