lamassu-server/lib/admin/public/bower_components/gridism/README.md

80 lines
3.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Gridism
A simple responsive CSS grid. [View the demo →](http://cobyism.com/gridism/)
## Why?
### My process
When I design web layouts, my thought process usually goes something like this:
> Alright, in this section, I want a bit thats one third of the sections width,
> and then next to that I want another bit thats two thirds of the sectionss width.
> Now, in the next section…
I dont think in 12 or 16 column grids. Instead, my mental model basically just consists of the page being divided up into multiple full-width vertical sections, and each vertical section being divided up into simple fractions of the section width.
### Existing grid frameworks
Most frameworks Ive used dont match that thought process *at all*. I usually have to:
1. Remember how many columns are in the grid for the particular framework Im using.
1. Decide how I want to divide up this particular sections content.
1. Mentally do the conversion from what I want to see (one quarter + three quarters, for example) into the number of columns I need for the grid Im using.
1. Remember the class naming structure for the framework Im using. Is it `.span3`, `.grid_3`, `.col-3`, or something else altogether?
1. Deal with other hassles like clearing floats, messing with column padding to have the gutters look right, indicating which elements are the first in a row, and so forth.
Only the second step should be necessary.
### Gridisms Goals
I couldnt find a framework that matched this mental model of how I work, so I started hacking on Gridism with the following goals:
- Class names should be memorable and self-evident.
- Gutters and basic content padding should be taken care of.
- Clearing floats should be done automatically.
- Wrapped grid sections should be independant of vertical page sections.
- Frequently required utility classes should be provided.
- Common patterns for Responsive Design™ should be built-in.
I hope you find that this project is living up to those goals. If not, please [create an issue](https://github.com/cobyism/gridism/issues/new) and let me know.
## Installation
### 1. Get the files
The easiest way to use Gridism in your project is via the [Bower](http://twitter.github.com/bower) package manager.
```sh
bower install gridism
```
Elsewise, [download the zip folder](https://github.com/cobyism/gridism/archive/gh-pages.zip), extract it, and copy `gridism.css` into your projects folder. Boom. Done.
### 2. Link the stylesheet
Add the following stylesheet to your HTMLs `<head>` section:
```html
<link rel="stylesheet" href="bower_components/gridism/gridism.css">
```
**Note:** If you didnt install using Bower, you need to adjust the path of CSS file to match your file structure.
### 3. Viewport scale
Add the following meta tag to your HTMLs `<head>` section:
```html
<meta name="viewport" content="width=device-width,initial-scale=1">
```
Without this meta tag, mobiles and tablets might load your page as a scaled-down version of the desktop size, instead of resizing the content to match the devices actual viewport width.
## Contributing
Id :heart: to receive contributions to this project. It doesnt matter if its just a typo, or if youre proposing an overhaul of the entire project—Ill gladly take a look at your changes. Fork at will! :grinning:.
## License
Go nuts. See [LICENSE](https://github.com/cobyism/gridism/blob/gh-pages/LICENSE) (MIT).