Skip to content

Commit 8d404f8

Browse files
committed
add project description to readme
1 parent d85b03c commit 8d404f8

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,32 @@
11
# tinycss
22

33
A very tiny CSS starter kit.
4+
5+
## Purpose
6+
7+
The purpose of this CSS starter kit, is to provide a decent out of the box experience, that does not get in the way of building your project.
8+
9+
## Getting Started
10+
11+
Take your pick. You have options:
12+
13+
- Copy the `.css` file and drop it in to your site as-is.
14+
- Grab the `.scss` file and incorporate that in your build process.
15+
16+
There isn't a wrong way to use it.
17+
18+
## Build and Test Locally
19+
20+
To build and run locally, you need to install `sass`
21+
22+
```ps
23+
choco install sass
24+
```
25+
26+
Once installed, you can run
27+
28+
```ps
29+
sass tinycss.scss tinycss.min.css --style compressed --watch
30+
```
31+
32+
to generate the files you see here, or use other cli options from sass to suit your specific needs.

0 commit comments

Comments
 (0)