Permalink
Browse files

Add Readme and license

  • Loading branch information...
1 parent a249892 commit e2329003f8d5ca7f47f0122fa523e6a36c4f7744 @knuton knuton committed Mar 16, 2012
Showing with 52 additions and 0 deletions.
  1. +7 −0 LICENSE
  2. +45 −0 README.md
View
@@ -0,0 +1,7 @@
+Copyright (c) 2012 Johannes Emerich
+
+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
@@ -0,0 +1,45 @@
+play-stylus
+-----------
+
+[stylus] [1] asset handling for [Play 2.0] [2], implemented as an [sbt] [3]
+plugin (very similar to Play's handling of CoffeeScript and LESS).
+
+Prerequisites
+=============
+
+The plugin assumes the availability of the `stylus` executable. With
+node.js and npm installed, run
+
+ npm install -g stylus
+
+to install stylus globally, thereby installing not only the module, but
+also the executable.
+
+Installation
+============
+
+In your Play application folder, add
+
+ addSbtPlugin("learnyousome" % "play-stylus" % "0.1.0" from "http://cloud.github.com/downloads/knuton/play-stylus/play-stylus-0.1.0.jar")
+
+to `project/plugins.sbt`.
+
+The plugin automatically registers for compilation of `app/assets/**/*.styl`, that is all stylus files in your `app/assets` directory.
+
+sbt settings
+============
+
+ - `compile:resource-generators`: The stylus file watcher is beind added here
+ - `play-stylus-entry-points`: All files matching `app/assets/**/*.styl`, except files starting in an underscore
+ - `play-stylus-options`: Currently not in use
+
+License
+=======
+
+Copyright (c) 2012 Johannes Emerich
+
+MIT-style licensing, for details see file LICENSE.
+
+[1]: http://learnboost.github.com/stylus/
+[2]: http://www.playframework.org/
+[3]: https://github.com/harrah/xsbt

0 comments on commit e232900

Please sign in to comment.