Factorio-Stdlib

Factorio Standard Library Project

Documentation

See the github pages for the latest generated documentation of the Factorio-stdlib

Generating the documentation from source

1. Install ldoc (apt-get install lua-ldoc on debian/ubuntu), see project for other operating systems

2. Generate the docs with ldoc src/*. Documentation will be placed in docs/

Unit Tests

The codebase is tested with busted. Test specifications are located under spec/

Contributing

Contributions are welcome! Please follow general lua coding standards and include ldoc-compatible comments.