Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 122 lines (93 sloc) 2.908 kb
a581f35 @ericam Add basic unit tests
authored
1 # Susy [a Compass plugin]
2
3 Susy is a semantic CSS grid system with a responsive twist.
4
5 The web is a responsive place,
6 from your lithe & lively development process
7 to your end user's super-tablet-multi-magic-lap-phone.
8 You need grids that are powerful, but custom;
9 reliable, but responsive.
10
11 Susy grids are fluid on the inside,
12 ready to respond at any moment,
13 but contained in the candy shell of your choice,
14 so they respond how and when and where you want them to.
15
16 This isn't another one-size-fits-all grid framework
17 that will make your sites look identical
18 and litter your markup with meaningless "col2of5" jargon.
19 We don't design your site or write your markup,
20 we just do the math and get out of your way.
21
22 ## Resources
23 - [Website](http://susy.oddbird.net)
24 - [Changelog](https://github.com/ericam/susy/blob/master/CHANGELOG.mkdn)
25 - [Tutorial](http://susy.oddbird.net/guides/getting-started/)
26 - [Reference](http://susy.oddbird.net/guides/reference/)
27 - [Sites using Susy](http://susy.oddbird.net/sites-using-susy/)
28 - [Twitter @CompassSusy](http://twitter.com/compasssusy/)
29
30 ## Contributing
31
32 We love contributions,
33 both as ideas and pull requests.
34 The core of Susy is all in the `/sass/` directory.
35
36 Once you make changes,
37 you can test them by building the gem
38 and installing it somewhere to test.
39 We also have unit tests that you can run.
40
41 ### Building the gem
42
43 You'll need Rake and Echoe installed:
44
45 ```bash
46 # command line
47 gem install rake
48 gem install echoe
49 ```
50
51 It might be helpful to bump the version number in `VERSION`,
52 but any changes you make there
53 should not be committed.
54
55 Then you can build:
56
57 ```bash
58 # command line
59 rake build
60 ```
61
62 Your new gem will appear in
63 a folder called `pkg`.
64 You can install it for testing
65 directly from there.
66
67 ```bash
68 # command line
69 gem install <path-to-file>
70 ```
71
72 ### Building the docs
73
74 If you are adding features
75 or changing how a current feature works,
76 your changes should be documented.
77 Or you might be helping us maintain the docs.
78 In either case,
79 you'll need to run the docs dev server
80 in order to see your changes.
81
82 In the `docs` folder:
83
84 ```bash
85 # command line
86 gem install bundler
87 bundle install
88 ```
89
90 The site is built with
91 [middleman](http://middlemanapp.com/).
92 To run the development server:
93
94 ```bash
95 # command line
620851f @ericam Update middleman instructions
authored
96 middleman
a581f35 @ericam Add basic unit tests
authored
97 ```
98
99 The server should now be running at `localhost:4567`.
100
101 Make any changes you need
102 under the `source` directory,
103 then commit your changes
104 and submit a pull request when you are done!
105
106 ### Tests
107
108 The tests we have are very basic at this point.
109 Simply go into the `test` directory
110 (with the latest Sass and Compass gems installed)
111 and run `compass compile --force`.
112
113 There should be no changes.
114 If there are changes,
115 go back and find what caused the change.
116 If the change was intentional,
117 simply commit the changed test files.
118 If it was not intentional,
119 go back and find what caused the problem.
120
121 Use `git diff` to see the changes.
Something went wrong with that request. Please try again.