diff options
author | Thijs Schreijer <thijs@thijsschreijer.nl> | 2018-11-22 18:41:22 +0300 |
---|---|---|
committer | Thijs Schreijer <thijs@thijsschreijer.nl> | 2018-11-23 23:08:28 +0300 |
commit | d70ac91eede03936db36b3fc31b62500242ed2e7 (patch) | |
tree | 20971375fd99be2b663b0379b58b9c2484debcda /README.md | |
parent | 2615db2914b46376a08e6045776e2206da390589 (diff) |
Release 1.6.01.6.0
Moved docs to ./docs for easy github publishing
Also added and fixed some additional links in the readme.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 17 |
1 files changed, 13 insertions, 4 deletions
@@ -57,6 +57,10 @@ Python standard libraries. * `utils`: `utils.string_lambda` converts short strings like '|x| x^2' into functions * `comprehension`: list comprehensions: `C'x for x=1,4'()=={1,2,3,4}` +## License + +Penlight is distributed under the [MIT license](https://github.com/stevedonovan/Penlight/blob/master/LICENSE.md) + ## Installation Using [LuaRocks](https://luarocks.org): simply run `luarocks install penlight`. @@ -75,12 +79,17 @@ in Lua for Windows. ## Building the Documentation Requires [ldoc](https://github.com/stevedonovan/LDoc), which is available -through LuaRocks. Then it's a simple matter of running `ldoc` in the docs folder. +through LuaRocks. Then it's a simple matter of running `ldoc .` from the repo. + +## Contributing -``` -Penlight/docs$ ldoc . -``` +Contributions are most welcome, please check the [contribution guidelines](https://github.com/stevedonovan/Penlight/blob/master/CONTRIBUTING.md). ## Running tests Execute `lua run.lua tests` to run the tests. Execute `lua run.lua examples` to run examples. + +## History + +For a complete history of the development of Penlight, please check the +[changelog](https://github.com/stevedonovan/Penlight/blob/master/CHANGELOG.md). |