/README.md

https://github.com/ajanthanm/cssfilterlab · Markdown · 105 lines · 66 code · 39 blank · 0 comment · 0 complexity · 16fc444264b6d74508d5b31dd0348ba9 MD5 · raw file

  1. CSS FilterLab
  2. =====
  3. Supported Browsers
  4. -----
  5. CSS FilterLab uses CSS Filters, an exciting web technology that's becoming available in more and more browsers.
  6. Check out [Can I Use](http://caniuse.com/css-filters) for availability information.
  7. Articles about FilterLab
  8. -----
  9. [Introducing CSS FilterLab](http://www.adobe.com/devnet/html5/articles/css-filterlab.html) by Razvan Caliman at Adobe
  10. [CSS FilterLab Detailed Walkthrough](http://blattchat.com/2012/10/02/css-filterlab/) from Alan Greenblatt's blog
  11. Note: These articles mention CSS Custom Filters, an experimental technology no longer available in CSS FilterLab.
  12. Contributing to FilterLab
  13. -----
  14. Pull requests are reviewed and accepted.
  15. Check out our [contributing page](CONTRIBUTING.md) for more info.
  16. Running FilterLab Locally
  17. -----
  18. ### Git Submodules
  19. The CodeMirror library is linked as a git submodule.
  20. After you clone the project on your machine you'll need to setup the submodules and pull in their code.
  21. <pre>
  22. cd ./path/to/css/filterlab/
  23. $ git submodule update --init
  24. </pre>
  25. ### Build
  26. CSS FilterLab uses [Grunt.js](http://gruntjs.com/) to concatenate and minify JavaScript & CSS resources. [Grunt.js](http://gruntjs.com/) is build on nodejs, so if you don't have it already installed, go to [node.js website](http://nodejs.org/) and follow the instructions to install it. After that use the command line node package manager to install grunt.js:
  27. <pre>
  28. $ sudo npm install -g grunt
  29. </pre>
  30. The grunt.js project file uses other node.js modules. To quicly install all the required libraries run "npm install" in the project folder.
  31. <pre>
  32. cd ./path/to/css/filterlab/
  33. $ sudo npm install
  34. </pre>
  35. You also need to make sure you have Ruby & Sass installed. If you're on OS X or Linux you probably already have them installed. Try <code>ruby -v</code> in your terminal. When you've confirmed you have Ruby installed, run <code>sudo gem install sass</code> to get Sass.
  36. To build CSS FilterLab, you need to run the "grunt" command line tool in the project folder. This will generate the "dist/" folder.
  37. <pre>
  38. cd ./path/to/css/filterlab/
  39. $ grunt
  40. </pre>
  41. ### File System Access
  42. CSS FilterLab requires XHR access, but that doesn't work very well when loaded from file:// URLs. For that reason running CSS FilterLab requires serving it from a server. The easiest way to do that on a Mac would be to use python's simple server:
  43. <pre>
  44. cd [./path/to/css/filterlab]/dist/
  45. python -m SimpleHTTPServer
  46. </pre>
  47. Open [http://localhost:8000](http://localhost:8000) in your browser.
  48. Legal
  49. ----
  50. Notices, terms and conditions pertaining to third party software are located at [http://www.adobe.com/go/thirdparty/](http://www.adobe.com/go/thirdparty/) and incorporated by reference herein.
  51. ### jQuery
  52. Copyright 2012 jQuery Foundation and other contributors [http://jquery.com/](http://jquery.com/)
  53. [MIT license](https://github.com/jquery/jquery/blob/master/MIT-LICENSE.txt)
  54. ### jQuery UI
  55. Copyright (c) 2012 Paul Bakaus, [http://jqueryui.com/](http://jqueryui.com/)
  56. [MIT license](http://jquery-ui.googlecode.com/svn/tags/latest/MIT-LICENSE.txt)
  57. ### ANGLE
  58. Copyright (c) 2002-2011 The ANGLE Project Authors. All rights reserved.
  59. Use of this source code is governed by a BSD-style license that can be
  60. found in the LICENSE file.
  61. This JavaScript library was automatically generated from the [ANGLE project](http://code.google.com/p/angleproject/)
  62. using [emscripten](https://github.com/kripken/emscripten)
  63. For more information go to [ANGLE.js](https://github.com/adobe/angle.js)
  64. ### CodeMirror
  65. Copyright (C) 2012 by Marijn Haverbeke <marijnh@gmail.com>
  66. [MIT License](http://codemirror.net/LICENSE)