mirror of
https://github.com/elua/elua.git
synced 2025-01-08 20:56:17 +08:00
17487f9ebe
- This should actually be a merge but we made a mistake on the initial repo creation and a merge was not possible. - Below there is a resumed log of the commit messages for the few steps, just for the record. - The merged commit messages for this work are: - Removing Portuguese doc content - Ignore folder names fixed on .gitignore - Removed doc files which content migrated to the CMS - docdata.lua updated accordingly - Doc build checked ok - Overall doc structure and contents still being refined - Removing folder cache from git versioning - Removing folder dist from git versioning. The folders above are generated by the buildall.lua script and are not part of the sources - Adding .gitignore file with objects info to inform git what to ignore - Removed file - Merge branch 'master' of git@repos.giga.puc-rio.br:elua-doc.git - Moving all files and folders to a working doc folder - Css updated - Index page added and CSS adjusts - Merge branch 'master' of git@repos.giga.puc-rio.br:elua-doc.git - Signed-off-by: Guilherme Sanchez <guilhermesanchezpacheco@gmail.com> - Merge branch 'master' of git@repos.giga.puc-rio.br:elua-doc.git - files deleted - Changed function that creates functions submenus. - Menu inserted with árvore, CSS adjusts, google search - Changed past design to new design - CSS updated - initial import - The commit ids were also preserved but they are related to this "other" work done on Led Lab. We'll keep the repo just in case. 4dce3f77c47b0c3001a2075a946e80ee52759b49 - Removing Portuguese doc content 78d8847525cacf045fe7e672cff6bd1e058a6a4b Ignore folder names fixed on .gitignore 48dee6b7962168ab1098bf709ead6f3cfe6b7964 - Removed doc files which content migrated to the CMS - docdata.lua updated accordingly - Doc build checked ok - Overall doc structure and contents still being refined 2aa2fe0c554db03dbc7029c34d0f4500fe625b37 - Removing folder cache from git versioning - Removing folder dist from git versioning The folders above are generated by the buildall.lua script and are not part of the sources - Adding .gitignore file with objects info to inform git what to ignore af6cc2890edf1855af319dc999a03feee5f9bee0 Removed file 6a180e72eb4f4860620cafc0685000e9f2174cfe Merge branch 'master' of git@repos.giga.puc-rio.br:elua-doc.git eb430112e78ae537459ab315e228ebca84bdf2d4 Moving all files and folders to a working doc folder d28a7c99489915630bd2625f3756fecf0d08ce37 Css updated 32836ffe382f04ab07c3e6f018c7b449a20d7a8d Index page added and CSS adjusts 1461d9957d9d25a1467cb57ab8717aa213a37e8d Merge branch 'master' of git@repos.giga.puc-rio.br:elua-doc.git ae1934c04f35a29e25bb4495ae8a31cd9c000b5b Signed-off-by: Guilherme Sanchez <guilhermesanchezpacheco@gmail.com> b5f31d70f1fac8d3fba325c9867a03f976775698 Merge branch 'master' of git@repos.giga.puc-rio.br:elua-doc.git ec9ad8446b7ea38b252c6a416e70774349835e45 files deleted bd7a80151b2030720ba8d8a303467d8c25a4b4b2 Changed function that creates functions submenus. 6a7494acaec694fadbb13520bcbccc51a6b95dfe Inserido menu com árvore, ajustes no CSS, busca do google e979f1c259d425c9a3be83f9cda20eddffe073bb Changed past design to new design. 381459e95286886b052103a0253e60b29e064d7a CSS updated 4f81d2f1195efe733fe5f97517be325d75937bc3 initial import
27 lines
1.7 KiB
Plaintext
27 lines
1.7 KiB
Plaintext
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 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
|
|
- 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 !
|
|
|