Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 131 lines (100 sloc) 3.233 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 ## Why is 1.0 a release candidate?
31
32 Susy 1.0 is stable and tested, all the features are in,
33 and we're ready to launch.
34 But our 1.0 depends on unreleased Sass features.
35 We think those features are stable as well,
36 and we'll do what it takes to stay on top of any changes they make,
37 but we can't officially land until they do.
38
39 ## Contributing
40
41 We love contributions,
42 both as ideas and pull requests.
43 The core of Susy is all in the `/sass/` directory.
44
45 Once you make changes,
46 you can test them by building the gem
47 and installing it somewhere to test.
48 We also have unit tests that you can run.
49
50 ### Building the gem
51
52 You'll need Rake and Echoe installed:
53
54 ```bash
55 # command line
56 gem install rake
57 gem install echoe
58 ```
59
60 It might be helpful to bump the version number in `VERSION`,
61 but any changes you make there
62 should not be committed.
63
64 Then you can build:
65
66 ```bash
67 # command line
68 rake build
69 ```
70
71 Your new gem will appear in
72 a folder called `pkg`.
73 You can install it for testing
74 directly from there.
75
76 ```bash
77 # command line
78 gem install <path-to-file>
79 ```
80
81 ### Building the docs
82
83 If you are adding features
84 or changing how a current feature works,
85 your changes should be documented.
86 Or you might be helping us maintain the docs.
87 In either case,
88 you'll need to run the docs dev server
89 in order to see your changes.
90
91 In the `docs` folder:
92
93 ```bash
94 # command line
95 gem install bundler
96 bundle install
97 ```
98
99 The site is built with
100 [middleman](http://middlemanapp.com/).
101 To run the development server:
102
103 ```bash
104 # command line
620851f @ericam Update middleman instructions
authored
105 middleman
a581f35 @ericam Add basic unit tests
authored
106 ```
107
108 The server should now be running at `localhost:4567`.
109
110 Make any changes you need
111 under the `source` directory,
112 then commit your changes
113 and submit a pull request when you are done!
114
115 ### Tests
116
117 The tests we have are very basic at this point.
118 Simply go into the `test` directory
119 (with the latest Sass and Compass gems installed)
120 and run `compass compile --force`.
121
122 There should be no changes.
123 If there are changes,
124 go back and find what caused the change.
125 If the change was intentional,
126 simply commit the changed test files.
127 If it was not intentional,
128 go back and find what caused the problem.
129
130 Use `git diff` to see the changes.
Something went wrong with that request. Please try again.