Permalink
Browse files

Add README.

  • Loading branch information...
1 parent b4aaf2c commit a81452638fc4bfd46b5041a88af50dfe3761602c @jcoglan committed Mar 17, 2012
Showing with 45 additions and 1 deletion.
  1. +44 −0 README.markdown
  2. +1 −1 package.json
View
@@ -0,0 +1,44 @@
+# Sylvester
+
+Vector and Matrix math for JavaScript. [See the website](http://sylvester.jcoglan.com)
+for documentation.
+
+
+## Development
+
+Sylvester is built using `jake` and tested with JS.Test. Tests should run on all
+target platforms, including browsers, Node and other JS runtimes.
+
+Build:
+
+ bundle install
+ bundle exec jake
+
+Test:
+
+ node test/console.js
+ open test/browser.html
+
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2007-2012 James Coglan
+
+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.
View
@@ -1,5 +1,5 @@
{ "name" : "sylvester"
-, "description" : "Vector and matrix math for JavaScript"
+, "description" : "Vector and Matrix math for JavaScript"
, "homepage" : "http://sylvster.jcoglan.com"
, "author" : "James Coglan <jcoglan@gmail.com> (http://jcoglan.com/)"
, "keywords" : ["vector", "matrix", "geometry", "math"]

0 comments on commit a814526

Please sign in to comment.