0ct0pu5/min
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Overhaul README

Browse source
This commit is contained in:
Owen Versteeg 2014-08-02 07:17:04 -04:00
parent f1ab995c24
commit 675184b485
1 changed files with 17 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
README.md
View file

@ -3,9 +3,7 @@ min
a tiny framework that makes websites pretty
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).
Written in LESS and Sass, compiled to CSS.
Congratulations 100th stargazer Matthew (@tropicalmug)
@ -13,9 +11,9 @@ Congratulations 100th stargazer Matthew (@tropicalmug)
995 bytes minified and gzipped.
###Compatible
Works with IE5 and onward. Yes, min is even responsive in IE5.
Works with IE5.5 and onward, as well as all other major browsers. Check out the [docs](http://minfwk.com/docs.html) for exact support data.
Of course, modern browsers give you pretty transitions.
Of course, modern browsers give you pretty transitions and rounded corners.
###License
MIT licensed.
@ -24,37 +22,29 @@ MIT licensed.
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!
If you want to contribute code:
1. Fork Min
2. You can edit either the Sass or LESS files.
- DO NOT change any of the compiled files, either by using build.sh or by editing them manually.
- Min uses tabs, all lowercase, and is liberal with spacing. Use this style.
- Don't skimp on spaces to save space - the YUI compressor does this automatically.
3. Submit a pull request. If you can (or if relevant), include the size of Min (minified and gzipped) before and after your changes, and take screenshots of what changed.
###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).
wget https://github.com/yui/yuicompressor/releases/download/v2.4.8/yuicompressor-2.4.8.jar
bash build.sh
###World's smallest? Really?
TL;DR Min really is is the world's CSS framework, however you slice it.
We personally feel that the criteria for "world's smallest CSS framework" are buttons, inputs, navbars, tables, icons, grids, headings, and standardization of these elements across the "Big 5" browsers (Chrome, Firefox, Opera, Safari, and Internet Explorer.) Of course, your criteria for what a CSS framework is are likely to be different, and thus you are encouraged to (on the Downloads page) download whatever parts you feel to be relevant. Thus, Min really is the world's smallest CSS framework, no matter your criteria for what a CSS framework is.
We personally feel that the criteria for "world's smallest CSS framework" are buttons, inputs, navbars, tables, icons, grids, headings, and standardization of these elements across the "Big 5" browsers (Chrome, Firefox, Opera, Safari, and Internet Explorer.) Of course, your criteria for what a CSS framework is are likely to be different, and thus you are encouraged to (on the Downloads page) download whatever parts you feel to be relevant. No matter what you select (and what you compare Min to) Min will be smaller. Thus, Min really is the world's smallest CSS framework, no matter your criteria for what a CSS framework is.
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/OwenVersteeg/min/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
###Sponsors
Thanks to @browserstack and @saucelabs for providing free unlimited browser testing.
If you would like to sponsor Min, contact Owen Versteeg: me@owenversteeg.com