Skip to content

Commit

Permalink
Add to readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
Mark Reeves committed Jul 26, 2017
1 parent 9c01458 commit ac72001
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 4 deletions.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,24 @@
# cssgrid
Responsive CSS helper classes based on CSS Grid Layout.

Responsive CSS helper classes based on [CSS3 Grid Layout module](https://www.w3.org/TR/css-grid-1/).

View [demo](https://bordertech.github.io/cssgrid/demo).

## Building

Use [yarn](https://yarnpkg.com/) to build.

1. `yarn install` (first time only)
2. `yarn build`

## IE support

IE is kinda broke. We have some beginnings of support but it does not yet include any attempt to set the `-ms-grid-column` offsets or use margins instead of `grid-space`. The file `ie.scss` will be built as a separate file. There is a var which allows this same IE specific CSS to be built into the main CSS file if required.

## Tests

The tests are not really set up yet. The `/test/` directory contains a couple of primitive HTML pages which depend on the built CSS. This is still very much a work in progress.

## Configuration

Configuration is done through Sass variables. More info later!
6 changes: 3 additions & 3 deletions sass/vars/_main.scss
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ $cg-gap-sm-m: ($cg-gap-m / 2) !default;
$cg-gap-sm-l: ($cg-gap-l / 2) !default;

// gaps on large viewports
$cg-gap-sm-s: ($cg-gap-s * 2) !default;
$cg-gap-sm-m: ($cg-gap-m * 2) !default;
$cg-gap-sm-l: ($cg-gap-l * 2) !default;
$cg-gap-lg-s: ($cg-gap-s * 2) !default;
$cg-gap-lg-m: ($cg-gap-m * 2) !default;
$cg-gap-lg-l: ($cg-gap-l * 2) !default;

0 comments on commit ac72001

Please sign in to comment.