1
0
mirror of https://github.com/elua/elua.git synced 2025-01-08 20:56:17 +08:00

The eLua doc is automatically generated by a Lua script contained here in the distro.
The html doc generated by this script is the exactly the same shown in our online site (www.eluaproject.net)

To generate the doc:
- make sure you have Lua installed in your machine (www.lua.org)
- make sure you have 'lfs' (Lua file system) and 'md5' modules installed on your machine. To install them:
  - in Windows: the simplest way is to install Lua for Windows (http://code.google.com/p/luaforwindows/) which comes with these modules installed
  - in Ubuntu:
    1. install luarocks
      $ sudo apt-get install luarocks
    2. install both modules using luarocks
      $ sudo luarocks install lfs md5
- make sure you have asciidoc (http://www.methods.co.nz/asciidoc/INSTALL.html) installed.       
- go to the /doc directory of this distro (you're probably here already :)
- run the script with
  $ lua buildall.lua
- the doc/site structure is generated in a new sub-folder called dist, where you can go and open any .html document. The left-side menu is actually 
  part of the global layout and is included in every page of the doc/site.
- enjoy eLua !