Skip to content

Commit

Permalink
Improve Sass compilation instructions in README for Sass watch & Gulp.
Browse files Browse the repository at this point in the history
  • Loading branch information
adamjohnson committed Sep 29, 2015
1 parent 9c49114 commit aa63b0e
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 11 deletions.
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,29 +5,32 @@ Brand Patterns

**Theme Description:** Theme for Brand Patterns.

**Developers name(s):** Adam Glenn
**Developers name(s):** May Day

**Stash repository URL:** [https://stash.development.wvu.edu/projects/CST/repos/brand-patterns/browse](https://stash.development.wvu.edu/projects/CST/repos/brand-patterns/browse)

**Dependencies necessary to work with this theme:** Sass.

**Other notes, comments, or reminders:**

1. Copy the files you want from the WVU Brand Patterns theme into your new theme.
2. Use the following command in Terminal from within your theme&rsquo;s top-level directory: <pre>sass --watch scss/styles.scss:stylesheets/styles.css</pre> or use Gulp to compile your Sass.
3. Test your theme in <a href="https://github.com/wvuweb/hammer-vm">Hammer</a>.
4. Push and sync your theme in CleanSlate.
1. Copy the files you want from the WVU Brand Patterns theme into your new theme.
1. Paste the following commands in Terminal from within your theme's top-level directory: `sass --watch scss/styles.scss:stylesheets/styles.css` and, in a new terminal window inside your theme, `sass --watch scss/ie8.scss:stylesheets/ie8.css` or use Gulp to compile your Sass.
1. Test your theme in [Hammer](https://github.com/wvuweb/hammer-vm).
1. Push and sync your theme in CleanSlate.

Need some help? [Read the CleanSlate documentation](https://cleanslatecms.wvu.edu/how-to/theme-development).

## Gulp
## Gulp & Brand Patterns

**Requirements**
* [NodeJS](https://nodejs.org)

You will need to install Node ~0.12.2

1. Install node modules `npm install`
1. Run Gulp
1. Download and install NodeJS from https://nodejs.org/en if you haven't already.
1. Install Gulp globally by entering `npm install -g gulp` in your terminal.
1. Navigate to your project's directory via terminal (something like `cd ~/Sites/cleanslate_themes/MY-SITE`)
1. Install node modules by typing `npm install`
1. Run Gulp by typing `gulp`.

**Note** the `gulpfile.js` in its base form will only compile your sass.
**Note:** the `gulpfile.js` in its base form will only compile your Sass.
2 changes: 1 addition & 1 deletion config.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

name: WVU Brand Patterns
description: This is the WVU Brand Patterns theme built for CleanSlate. Originally authored by Adam Glenn.
description: This is the WVU Brand Patterns theme built for CleanSlate. Originally authored by May Day.

# Default Templates
# Specify which templates show up by default when creating a page
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"type": "git",
"url": "https://stash.development.wvu.edu/scm/cst/brand-patterns.git"
},
"author": "Adam Glenn <adam.glenn@mail.wvu.edu>",
"author": "May Day <may.day@mail.wvu.edu>",
"license": "MIT",
"devDependencies": {
"gulp": "^3.9.0",
Expand Down

0 comments on commit aa63b0e

Please sign in to comment.