Skip to content

Commit a7639ed

Browse files
committed
Update README.md for Less and Stylus.
1 parent e0e4f17 commit a7639ed

File tree

1 file changed

+22
-8
lines changed

1 file changed

+22
-8
lines changed

README.md

+22-8
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,21 @@ what css is causing me problems.
1414

1515
# Getting started
1616

17-
If you like sass like me, you can just drop this partial into your includes. If you want to turn off
18-
outlines, just set the variable
17+
If you like pre-processing your css like I do, you can drop any of the Sass, Less, or Stylus partials into your includes.
18+
Each version of Pesticide sets a debug variable at the top of the partial, which you can set to false if you want to turn off
19+
outlines:
1920
```
20-
$pesticide-debug
21+
// sass
22+
$pesticide-debug: false;
2123
```
22-
at the top of pesticide.scss to false (or anything that isn't true).
24+
```
25+
// less
26+
@pesticide-debug: false;
27+
````
28+
```
29+
// stylus
30+
pesticide-debug = false
31+
````
2332
2433
If you like to use vanilla css, you can either keep it commented out at the bottom of your css file,
2534
or include it as an extra request in the head of your html file like so...
@@ -33,21 +42,26 @@ Make sure not to send it to production though because that wouldn't be the best.
3342
# Development
3443
3544
If you want to tweak the source code you might find it useful to use some of the available gulp tasks
36-
included with the project. To set up automation with gulp just press the following keys
45+
included with the project. To set up automation with gulp just press the following keys:
3746
```
3847
cd pesticide
3948
npm install -g gulp
4049
npm install
41-
gulp
4250
```
43-
51+
Because Pesticide comes in Sass, Less, and Stylus flavors, you can adjust gulp to run with your pre-processor of choice. To do so, simply change the `preProcessor` variable at the top of the gulpfile to either sass, less or stylus as a string value. For example:
52+
```
53+
preProcessor = 'sass';
54+
```
55+
Then run `gulp`.
4456
That will set up:
4557
4658
* Livereload
47-
* Sass compilation
59+
* Stylesheet compilation
4860
* Csslint
4961
* CSS minification
5062
63+
*It's important to note that Sass is the default pre-processor set in the gulpfile, so if you plan to use Less or Stylus, you should change the `preProcessor` value before running `gulp`.*
64+
5165
# Chrome Extension
5266
5367
The source for the Pesticide Chrome extension is included beginning from v0.2. The extension is [available in the Chrome Webstore here.](https://chrome.google.com/webstore/detail/bblbgcheenepgnnajgfpiicnbbdmmooh).

0 commit comments

Comments
 (0)