Aire-One
/
LDoc2tl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #303 from AntumDeluge/touchups

This commit is contained in:
Caleb Maclennan 2020-09-30 00:25:56 +03:00 committed by GitHub
parent 68d516ff34 bdcdce0188
commit 48cc9c2f1f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
readme.md
View File

@ -5,10 +5,10 @@ Copyright (C) 2011-2012 Steve Donovan.
## Rationale ## Rationale
This project grew out of the documentation needs of This project grew out of the documentation needs of
[Penlight](https://github.com/stevedonovan/Penlight) (and not always getting satisfaction [Penlight](https://github.com/lunarmodules/Penlight) (and not always getting satisfaction
with LuaDoc) and depends on Penlight itself. (This allowed me to _not_ write a lot of code.) with LuaDoc) and depends on Penlight itself. (This allowed me to _not_ write a lot of code.)
The [API documentation](http://stevedonovan.github.com/Penlight/api/index.html) of Penlight The [API documentation](http://lunarmodules.github.com/Penlight/api/index.html) of Penlight
is an example of a project using plain LuaDoc markup processed using LDoc. is an example of a project using plain LuaDoc markup processed using LDoc.
LDoc is intended to be compatible with [LuaDoc](http://keplerproject.github.io/luadoc/) and LDoc is intended to be compatible with [LuaDoc](http://keplerproject.github.io/luadoc/) and
@ -40,9 +40,9 @@ documentation](http://stevedonovan.github.com/winapi/api.html); this is generate
## Installation ## Installation
This is straightforward; the only external dependency is This is straightforward; the only external dependency is
[Penlight](https://github.com/stevedonovan/Penlight), which in turn needs [Penlight](https://github.com/lunarmodules/Penlight), which in turn needs
[LuaFileSystem](http://keplerproject.github.com/luafilesystem/). These are already present [LuaFileSystem](http://keplerproject.github.com/luafilesystem/). These are already present
in Lua for Windows, and Penlight is also available through LuaRocks as `luarocks install in [Lua for Windows](https://github.com/rjpcomputing/luaforwindows), and Penlight is also available through [LuaRocks](https://luarocks.org/) as `luarocks install
penlight`. penlight`.
Unpack the sources somewhere and make an alias to `ldoc.lua` on your path. That is, either Unpack the sources somewhere and make an alias to `ldoc.lua` on your path. That is, either