Added link to docs to README

This commit is contained in:
nucular 2016-03-02 00:47:03 +01:00
parent 5c6deca485
commit e300cb8548

View File

@ -47,4 +47,13 @@ local buffer = sound:generateString()
device:play(buffer, #buffer)
```
**More documentation is available at the [Project Wiki](https://github.com/nucular/sfxrlua/wiki)**
Documentation
-------------
[**The latest documentation build is available here**](http://nucular.github.io/sfxrlua/)
This project uses [LDoc](http://stevedonovan.github.io/ldoc/) for autogenerated
API documentation.
(Reminder to self: `ldoc . && git subtree push --prefix doc origin gh-pages`)
The old documentation is still available on the
[Project Wiki](https://github.com/nucular/sfxrlua/wiki).