diff --git a/README.md b/README.md index 4044b57..8848479 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ min a tiny framework that makes websites pretty -Written in LESS, compiled to CSS. Access the current beta [here](http://minfwk.com/beta.html). The "beta" page hotlinks the latest version of the Min LESS files. +Written in LESS and Sass, compiled to CSS. Access the current beta [here](http://minfwk.com/beta.html). The "beta" page hotlinks the latest version of the Min LESS files. To download Min, go [here](http://minfwk.com/download.html). @@ -20,6 +20,30 @@ Of course, modern browsers give you pretty transitions. ###License MIT licensed. +###Contributing + +We encourage you to contribute anything you can to Min. If you have an idea for a new feature, open a new issue with the Enhancement tag. + +To contribute code: + +1. Fork Min. +2. At this point, you can choose between editing the Sass files in the `sass` folder or the LESS files in the `less` folder. Feel free to edit one but ignore the other; [Scott O'Hara](https://github.com/scottaohara), the Sass version maintainer, will translate your changes to Sass from LESS or vice versa. +3. Make sure that your pull request will not bring Min's total size above 995 bytes minified and gzipped. +4. Make a pull request with your changes. In your pull request, you MUST: + - State the size of the entire Min framework before AND after your changes (run build.sh on your changed files, gzip entireframework.min.css and measure its size) + - Say why you made these changes + - Describe any possible issues with the changes, or reasons why they might not be merged + - If your changes affect Min's appearance, take screenshots of the affected Min; if you can, include multiple browsers using [Browserstack](http://www.browserstack.com/screenshots). +5. Finally, remember: + - The :star2: special files :star2: are only updated by the project founder, Owen Versteeg, and they are only updated after extensive compatibility, size, and bug testing. They are built by the `build.sh` file. NEVER MODIFY ANY OF THE :star2: special files :star2:, which are: + - CNAME + - compiledcss.js + - entireframework.min.css + - mingziphotlink.php + - Min uses tabs, all lowercase, and proper spacing. If your PR contains wacky spacing changes it'll probably be rejected. + - Don't skimp on spaces to save space; the YUI compressor does this automatically at build time. + - Contributing to Min is highly encouraged. Don't be shy! + ###Building the latest Min WARNING! This will build the latest, pre-release version of Min. It may be broken. If you want to use an already-built Min, it's available in the file entireframework.min.css as well as through the [downloads page](http://minfwk.com/download.html).