diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..1777578 --- /dev/null +++ b/LICENSE @@ -0,0 +1,19 @@ +Copyright (c) 2016 Alex Palaistras + +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. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..32379eb --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# Fawkss — The CSS preprocessor for people who dislike CSS preprocessors [![MIT License][license-svg]][license-url] + +Fawkss [fɔːks] is a simple CSS preprocessor built as a single AWK (nawk/gawk/mawk) script. Syntactically, it borrows as much as possible from the SASS language, for convenience and familiarity. + +This is more of a fun project than a production-ready piece of software, though it may find some use for people needing simple additions to CSS without pulling in the massive ecosystem that comes with Less.js/SASS etc. + +## Status + +Currently, the following features are implemented: + + * C99/C++-style comments (.i.e. `// This is a comment`) + * Variables + +A full test-suite is provided (depending only on Bash and AWK), which should serve as a good example of the existing feature-set. + +## Roadmap + +It is intended that the script never balloons to more than ~1000 lines of code. I'm trying to tackle the most important features yet and see how well they fit within the AWK mindset. + +That being said, I do not plan to implement any context-sensitive functionality (such as nesting etc.), which may be nigh-impossible in AWK anyways. Consider it a feature. + +## Are you kidding me? + +Nope. I wouldn't suggest you actually use this for anything, though. + +## License + +All code in this repository is covered by the terms of the MIT License, the full text of which can be found in the LICENSE file. + +[license-url]: https://github.com/deuill/go-php/blob/master/LICENSE +[license-svg]: https://img.shields.io/badge/license-MIT-blue.svg \ No newline at end of file