Skip to content
This repository was archived by the owner on Dec 11, 2021. It is now read-only.

Commit 0bf7464

Browse files
jzaefferersfrisk
authored andcommitted
README: Improve wording, formatting, links, headers
At this point dropping "an attempt" in the opening paragraph seems well justified. The rest of the wording there is still reasonably cautious. The rest should be even less problematic. Unless there's a reason to keep links in plaintext. Closes gh-93 Closes gh-115
1 parent 2094699 commit 0bf7464

File tree

1 file changed

+19
-17
lines changed

1 file changed

+19
-17
lines changed

README.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,56 @@
1-
Chassis is an attempt at creating open standards designed for CSS libraries, JavaScript UI libraries, and web developers in general. This project will define standards for markup and class names for common widgets and patterns, as well as an implementation of those standards. Just like DOM libraries can build upon [Sizzle](https://github.com/jquery/sizzle), we hope UI libraries will build upon this.
1+
Chassis is creating open standards designed for CSS libraries, JavaScript UI libraries, and web developers in general. This project will define standards for markup and class names for common widgets and patterns, as well as an implementation of those standards. Similar to how DOM libraries can build upon [Sizzle](https://github.com/jquery/sizzle), we hope UI libraries will build upon this project.
22

33
## Goals
44

55
* **Broad Device Support**: The number of devices being used around the world continues to grow. We aim to support a wide range of devices without sacrificing usability or aesthetics.
6-
* **Performance**: The styles applied to your web page have a significant impact on how quickly the page can be rendered and how smoothly the page scrolls, among other things.
6+
* **Performance**: The styles applied to your web page have a significant impact on, for example, how quickly the page can be rendered and how smoothly the page scrolls. We aim to keep this impact as small as possible.
77
* **Modularity**: Each component will be designed as separate modules, allowing customized builds of just the pieces you need.
8-
* **Pushing Web Standards**: We will work with W3C and WHATWG to improve CSS standards based on our work and feedback from the community.
8+
* **Pushing Web Standards**: We will work with the W3C and WHATWG to improve CSS standards based on our work and feedback from the community.
99
* **Collaboration**: We value input and collaboration from the community. We don't want to just build yet another CSS library; we want to improve collaboration and interoperability across projects.
1010

1111
## Project Collaboration and Interoperability
1212

13-
If you maintain a JavaScript library that has UI components, we'd love for you to join our efforts. We'd be happy to hear your feedback and work through updates of your project(s) to support CSS Framework. If you have the time and interest to help define the standards and improve on our implementation, that's even better! Check out the [contribution guidelines](https://github.com/jquery/css-chassis/blob/master/CONTRIBUTING.md) for more information.
13+
If you maintain a JavaScript library that has UI components, we'd love for you to join our efforts. We'd be happy to hear your feedback and work through updates of your project(s) to support Chassis. If you have the time and interest to help define the standards and improve on our implementation, that's even better! Check out the [contribution guidelines](https://github.com/jquery/css-chassis/blob/master/CONTRIBUTING.md) for more information.
1414

1515

1616
## Getting started
1717

1818
### Prerequisites
1919

20-
Node.js and npm should be installed. [[installer]](http://nodejs.org/download/)
20+
[Node.js and npm](http://nodejs.org/download/) should be installed, [as well as `grunt-cli`](http://gruntjs.com/getting-started).
2121

2222
### Building
2323

24-
Once you've cloned Chassis to your machine, run `npm install` and `grunt build` from the root Chassis directory.
25-
24+
Once you've cloned Chassis to your machine, run these commands:
2625
```
2726
$ npm install
2827
$ grunt build
2928
```
3029

3130
### Performance testing
3231

33-
## Setup
32+
#### Setup
3433

3534
* Follow the steps for building above
36-
* Ensure you have both firefox and chrome browsers installed
37-
* Download CouchDB from [http://couchdb.apache.org/#download](http://couchdb.apache.org/#download)
38-
* Start CouchDB
35+
* Ensure you have both Firefox and Chrome browsers installed
36+
* [Download and start CouchDB](http://couchdb.apache.org/#download)
3937

40-
## Running the tests
38+
#### Running the tests
4139

42-
Once you have completed the setup run `grunt perf` from the root of the Chassis directory.
40+
Once you have completed the setup run this:
4341
```
4442
$ grunt perf
4543
```
4644

47-
####DO NOT USE YOUR COMPUTER WHILE TESTS ARE RUNNING
45+
*__DO NOT USE YOUR COMPUTER WHILE TESTS ARE RUNNING__*
4846

49-
When the tests complete go to [http://localhost:5984/css-performance/_design/site/index.html#/page-select](http://localhost:5984/css-performance/_design/site/index.html#/page-select) to view results
47+
Once the tests completed, [view the results](http://localhost:5984/css-performance/_design/site/index.html#/page-select).
5048

51-
## Viewing the test pages
49+
#### Viewing the test pages
5250

53-
Follow the steps above to build. Once that is complete run `grunt connect:dev` from the root of the Chassis directory. This will start a connect server that will run until you stop it. Then go to http://localhost:4200/framework/{framework name}/component/{component name}/count/{ # of components to render}/ and you can see the generated test page.
51+
Follow the steps above to build. Once that is complete run this:
52+
```
53+
$ grunt connect:dev
54+
```
55+
This will start a connect server that will run until you stop it (`Ctrl+C`). Then go to http://localhost:4200/framework/{framework name}/component/{component name}/count/{ # of components to render}/ and you can see the generated test page.
5456

0 commit comments

Comments
 (0)