Prototype Oriented Programming for Lua
Lua Makefile
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
build-aux
lib/std/prototype
spec
.gitignore
.luacov
.travis.yml
AUTHORS.md
LICENSE.md
Makefile
NEWS.md
README.md
std.prototype-git-1.rockspec

README.md

Prototype Oriented Programming with Lua

Copyright (C) 2000-2018 std.prototype authors

License travis-ci status codecov.io Stories in Ready

This is a collection of Prototype Oriented Programming libraries for Lua 5.1 (including LuaJIT), 5.2 and 5.3. The libraries are copyright by their authors (see the AUTHORS file for details), and released under the MIT license (the same license as Lua itself). There is no warranty.

prototype has no run-time prerequisites beyond a standard Lua system, though it will take advantage of stdlib, strict and typecheck if they are installed.

Installation

The simplest and best way to install prototype is with LuaRocks. To install the latest release (recommended):

    luarocks install prototype

To install current git master (for testing, before submitting a bug report for example):

    luarocks install http://raw.githubusercontent.com/lua-stdlib/prototype/master/prototype-git-1.rockspec

The best way to install without LuaRocks is to copy the prototype folder and its contents into a directory on your package search path.

Documentation

The latest release of these libraries is documented in LDoc. Pre-built HTML files are included in the release.

Bug reports and code contributions

These libraries are written and maintained by their users.

Please make bug reports and suggestions as GitHub Issues. Pull requests are especially appreciated.

But first, please check that your issue has not already been reported by someone else, and that it is not already fixed by master in preparation for the next release (see Installation section above for how to temporarily install master with LuaRocks).

There is no strict coding style, but please bear in mind the following points when proposing changes:

  1. Follow existing code. There are a lot of useful patterns and avoided traps there.

  2. 3-character indentation using SPACES in Lua sources: It makes rogue TABs easier to see, and lines up nicely with 'if' and 'end' keywords.

  3. Simple strings are easiest to type using single-quote delimiters, saving double-quotes for where a string contains apostrophes.

  4. Save horizontal space by only using SPACEs where the parser requires them.

  5. Use vertical space to separate out compound statements to help the coverage reports discover untested lines.