Skip to content

Commit 692d075

Browse files
committed
Documentation: Copy back Wiki Home
Closes gh-477
1 parent 5dd84b2 commit 692d075

File tree

1 file changed

+46
-11
lines changed

1 file changed

+46
-11
lines changed

README.md

Lines changed: 46 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,56 @@
55

66
# CSSLint
77

8-
CSSLint is a tool to help point out problems with your CSS code.
9-
It does basic syntax checking as well as applying a set of rules
10-
to the code that look for problematic patterns or signs of inefficiency.
11-
The rules are all pluggable, so you can easily write your own or omit ones
12-
you don't want. You can find information about both using CSS Lint and
13-
contributing to the project in the wiki: https://github.com/CSSLint/csslint/wiki
8+
CSSLint is an open source CSS code quality tool originally written by
9+
[Nicholas C. Zakas](http://www.nczonline.net/) and
10+
[Nicole Sullivan](http://www.stubbornella.org/). It was released in June 2011 at
11+
the Velocity conference.
1412

15-
## Contributors
13+
A [lint](http://en.wikipedia.org/wiki/Lint_programming_tool) tool performs
14+
[static analysis](http://en.wikipedia.org/wiki/Static_code_analysis) of source
15+
code and flags patterns that might be errors or otherwise cause problems for the
16+
developer.
17+
18+
CSSLint is a tool to help point out problems with your CSS code. It does basic
19+
syntax checking as well as applying a set of rules to the code that look for
20+
problematic patterns or signs of inefficiency. The rules are all pluggable, so
21+
you can easily write your own or omit ones you don't want.
22+
23+
## Integration
24+
25+
### Command Line Interface
26+
27+
All about the command line interface for CSSLint. If you'd rather use a CLI
28+
program to verify your CSS instead of using the web site, then this guide is
29+
your best friend.
30+
https://github.com/CSSLint/csslint/wiki/Command-line-interface
31+
32+
### Build System
1633

17-
### Creators
34+
Once you're familiar with the CSSLint command line interface, the next step is
35+
to integrate it into your build system. This guide walks through using CSSLint
36+
as part of your build.
37+
https://github.com/CSSLint/csslint/wiki/Build-System-Integration
1838

19-
1. Nicole Sullivan, http://www.stubbornella.org
20-
1. Nicholas C. Zakas, http://www.nczonline.net
39+
### IDE
2140

22-
### Contributors
41+
You can integrate CSSLint into your favorite IDE to make checking your CSS code
42+
quality easy. In fact, some IDEs already have CSSLint built in.
43+
https://github.com/CSSLint/csslint/wiki/IDE-integration
44+
45+
## Rules
46+
47+
Not sure why a rule is important? This guide talks about each of the CSSLint
48+
rules and explains how the rule is designed to improve your CSS.
49+
https://github.com/CSSLint/csslint/wiki/Rules
50+
51+
## Developer Guide
52+
53+
If you want to contribute to the project, or even just tinker on your own,
54+
this guide explains how to get the source and work with it.
55+
https://github.com/CSSLint/csslint/wiki/Developer-Guide
56+
57+
## Contributors
2358

2459
1. Samori Gorse, https://twitter.com/shinuza (Rules, Non-zero Exit Code for CLI)
2560
1. Eitan Konigsburg, https://twitter.com/eitanmk (Rhino CLI)

0 commit comments

Comments
 (0)