Skip to content

Commit

Permalink
A lot more info in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kevmoo committed Sep 7, 2011
1 parent a2c8d27 commit 8f659d2
Showing 1 changed file with 31 additions and 2 deletions.
33 changes: 31 additions & 2 deletions readme.md
@@ -1,7 +1,36 @@
This is a work in progress. Stay tuned...
# PL - A Javascript Library

Used in:
By your friends at [Pixel Lab](http://thinkpixellab.com)

We do a lot of work in Javascript. This is our collection of libraries we have used and are using for projects. Where code was borrowed, we let you know. Aside from a bunch of miscellaneous, the big chunks are:

* [Box2d](https://github.com/thinkpixellab/pl/tree/master/src/box2d) - A 2D physics library
* [QR](https://github.com/thinkpixellab/pl/tree/master/src/qr) - A QR code library
* [Retained](https://github.com/thinkpixellab/pl/tree/master/src/retained) - A a [retained-mod](http://en.wikipedia.org/wiki/Retained_mode) graphics library for canvas

## Notes

* The library is designed to be used with [Google's Closure Tools](http://code.google.com/closure/).
* [KBuild](https://github.com/kevmoo/kbuild) is a sister project to make it easier to use the closure tools.

## Getting started...

*Need more here...*

To get the examples working, put a copy of the closure library in a directory named `closure` next to pl. A simple way to see how this works is to clone one of the projects below (ThinkQR is the smallest). Make sure you initialize submodules.

## Used in

* The [Box2d Demo site](https://github.com/thinkpixellab/box2dWeb)
* [Agent 008 Ball](https://github.com/thinkpixellab/agent8ball)
* [ThinkQR](https://github.com/thinkpixellab/thinkqr)

## The MIT License

Copyright (c) 2011 Pixel Lab

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 comments on commit 8f659d2

Please sign in to comment.