Layout

Project Files

• stdlib/ Contains the meat and potatoes of the stdlib project, See the API-Doc
• spec/ contains all of the busted unit tests for the Factorio Stdlib. If you have busted installed, you can run the test suite using make test or simply, busted in the main project directory.
• love/ contains graphical debugging programs written in love.
• examples/ contains examples on how to use some of the stdlib code
• doc/ contains ldoc specific configuration, used for the auto-generated documentation that appears on the github pages
• .build/ is an autogenerated, git-ignored directory that documentation is generated in. It will only exist if you've run make all.
• .circleci/ describes how to auto-generate the github pages documentation using the circle-ci service.
• wiki contains this wiki as a submodule.

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.

[