Skip to content

Commit 6a229c1

Browse files
author
Donovan Hutchinson
committed
Clearer readme
1 parent 44653e5 commit 6a229c1

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,24 @@
1-
# Skeleton for simple HTML/JS projects
1+
# Starter for HTML/CSS/JS projects
22

33
Includes Gulp to compile Sass into CSS, along with Autoprefixer and Browser Sync.
44

55
## Setup
66

77
Before starting, you'll need [Node](https://nodejs.org/) (which includes NPM).
88

9-
Clone this repo, then run `npm install` to install dependencies.
9+
Then, clone this repo to your local computer using this command:
1010

11-
## Usage
11+
git clone git@github.com:cssanimation/gulp-sass-starter.git starter
1212

13-
Edit CSS (Sass) and JavaScript in the `src/` folder. The Gulp script will process these and the stylesheets and javascripts folders will be automatically populated.
13+
With the files downloaded, navigate to your `starter` folder on the command line (or Terminal) and run `npm install` to set things up.
1414

15-
The command `gulp` will build the site, generating the CSS in the stylesheets folder, as well as combining JavaScript files into the javascripts folder.
15+
If that doesn't work, it may be necessary to use `sudo npm install`.
16+
17+
With this set up, you should now be able to run:
18+
19+
gulp
20+
21+
This will process any Sass (SCSS) files and launch a web browser showing the current files. Making changes to the files should result in the page updating automatically.
1622

1723
## Questions
1824

0 commit comments

Comments
 (0)