diff options
| author | Artur Signell <artur@vaadin.com> | 2012-09-07 16:43:01 +0300 |
|---|---|---|
| committer | Artur Signell <artur@vaadin.com> | 2012-09-07 16:43:01 +0300 |
| commit | 544152d1adc3a098445f7b11b4651fcc3c2f13bc (patch) | |
| tree | 755041e36ad5f39ddc4d72db0f977ef68da7e047 /theme-compiler/README | |
| parent | 733a7fd89068939b44f357e9eb88e197427097da (diff) | |
| download | vaadin-framework-544152d1adc3a098445f7b11b4651fcc3c2f13bc.tar.gz vaadin-framework-544152d1adc3a098445f7b11b4651fcc3c2f13bc.zip | |
Renamed sass -> theme-compiler for consistency (#9299)
Diffstat (limited to 'theme-compiler/README')
| -rw-r--r-- | theme-compiler/README | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/theme-compiler/README b/theme-compiler/README new file mode 100644 index 0000000000..4d9482763f --- /dev/null +++ b/theme-compiler/README @@ -0,0 +1,11 @@ +This project compiles SCSS into CSS. +It parses the SCSS into a tree. + +Classes +======= +SassCompiler: This is the main class that can be run from command line. First parameter is for a scss file to be compiled. Second parameter is optional and is a reference to a file where you want the compiled css. If file doesn't exist, it will be deleted. If file exists, it will be deleted and recreated. If second argument is left out, the css will be printed into standard out. +ScssStylesheet: When Scss/Css is parsed in, it will be represented in memory as this file. Reference is got through static get(File file) where file is input. +Parser: A JavaCC compiled java class that parses the input and notifies the DocumentHandler on what nodes it encounters. +Parser.jj: Source for the Parser class. +SCSSDocumentHandlerImpl: Class that takes in calls from parser and creates nodes into ScssStylesheet based on those calls. +Node package: All the nodes representing the Scss/Css in tree format
\ No newline at end of file |