Embedded/elua
1
0
Fork 0
mirror of https://github.com/elua/elua.git synced 2025-01-08 20:56:17 +08:00
Code Issues Projects Releases Wiki Activity

updated doc build instructions

Browse Source
This commit is contained in:
Bogdan Marinescu 2011-02-04 23:11:27 +00:00
parent ed482fa057
commit 1c05a25a43
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/README.TXT
View File

@ -4,13 +4,19 @@ The html doc generated by this script is the exactly the same shown in our onlin
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:
* 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.
- make sure you have Python installed and the Python installation directory is in your PATH (you might have to add it manually in Windows).
Python is needed by AsciiDoc (below).
- make sure you have AsciiDoc (http://www.methods.co.nz/asciidoc/INSTALL.html) installed. If you're using Windows you have a bit more work to do:
* make sure that the AsciiDoc installation directory is in your PATH
* create a file named "asciidoc.bat" in the AsciiDoc instalation directory with the following line in it:
@python "c:\Program Files\asciidoc-8.6.2\asciidoc.py" %*
(substitute "c:\Program Files\asciidoc-8.6.2" with you AsciiDoc instalation directory).
- go to the /doc directory of this distro (you're probably here already :)
- run the script with
$ lua buildall.lua