Skip to content

Commit a479de3

Browse files
committed
Update docs
1 parent 21b70b4 commit a479de3

File tree

1 file changed

+31
-1
lines changed

1 file changed

+31
-1
lines changed

README.rst

+31-1
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,8 @@ Run scripts in the VM.
9090
9191
Refer to `Lua Reference Manual <http://www.lua.org/manual/5.1/>`_ and `Go doc <http://godoc.org/github.com/yuin/gopher-lua>`_ for further information.
9292

93+
Note that elements that are not commented in `Go doc <http://godoc.org/github.com/yuin/gopher-lua>`_ equivalent to `Lua Reference Manual <http://www.lua.org/manual/5.1/>`_ , except GopherLua uses objects instead of Lua stack indcies.
94+
9395
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9496
Data model
9597
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -193,6 +195,16 @@ You can also create an LState object that has the callstack & registry size spec
193195
194196
An LState object that has been created by ``*LState#NewThread()`` inherits the callstack & registry size from the parent LState object.
195197

198+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
199+
Miscellaneous lua.NewState options
200+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
201+
- **Options.SkipOpenLibs bool(default false)**
202+
- By default, GopherLua opens all built-in libraries when new LState is created.
203+
- You can skip this behaviour by setting this to ``true`` .
204+
- **Options.IncludeGoStackTrace bool(default false)**
205+
- By default, GopherLua does not show Go stack traces when panics occur.
206+
- You can get Go stack traces by setting this to ``true`` .
207+
196208
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
197209
API
198210
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -652,6 +664,20 @@ How to Contribute
652664
----------------------------------------------------------------
653665
Any kind of contributions are welcome.
654666

667+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
668+
Building GopherLua
669+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
670+
GopherLua uses simple inlining tool for generate efficient codes. This tool requires python interpreter. Files name of which starts with ``_`` genarate files name of which does not starts with ``_`` . For instance, ``_state.go`` generate ``state.go`` . You do not edit generated sources.
671+
To generate sources, some make target is available.
672+
673+
.. code-block:: bash
674+
675+
make build
676+
make glua
677+
make test
678+
679+
You have to run ``make build`` before committing to the repository.
680+
655681
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
656682
Pull requests
657683
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -694,8 +720,12 @@ Libraries for GopherLua
694720

695721
- `gopher-luar <https://github.com/layeh/gopher-luar>`_ : Custom type reflection for gopher-lua
696722
- `gluamapper <https://github.com/yuin/gluamapper>`_ : Mapping a Lua table to a Go struct
723+
- `gluare <https://github.com/yuin/gluare>`_ : Regular expressions for gopher-lua
697724
- `gluahttp <https://github.com/cjoudrey/gluahttp>`_ : HTTP request module for gopher-lua
698-
- `gopher-json <https://github.com/layeh/gopher-json>`_ : a simple JSON encoder/decoder for gopher-lua
725+
- `gopher-json <https://github.com/layeh/gopher-json>`_ : A simple JSON encoder/decoder for gopher-lua
726+
- `gluayaml <https://github.com/kohkimakimoto/gluayaml>`_ : Yaml parser for gopher-lua
727+
- `glua-lfs <https://github.com/layeh/gopher-lfs>`_ : Partially implements the luafilesystem module for gopher-lua
728+
- `gluaurl <https://github.com/cjoudrey/gluaurl>`_ : A url parser/builder module for gopher-lua
699729

700730
----------------------------------------------------------------
701731
License

0 commit comments

Comments
 (0)