Skip to content
This repository has been archived by the owner on Oct 6, 2018. It is now read-only.

Commit

Permalink
Issue #108: Remove style.scss, style.css, setting.scss from the repo …
Browse files Browse the repository at this point in the history
…and package json files
  • Loading branch information
Chris Pearce committed Apr 25, 2015
1 parent d75e33a commit 1deaf70
Show file tree
Hide file tree
Showing 10 changed files with 27 additions and 5,439 deletions.
6 changes: 3 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Specific files #
###################
style-test.scss
test.scss
test.html
style.css.map
Gruntfile.js
test.css.map
test.css


# Compiled source #
Expand Down
9 changes: 3 additions & 6 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
.gitignore
.npmignore
.version
settings.scss
style.scss
style-test.scss
CHANGELOG.md
bower.json
test.html
CHANGELOG.md
test.html
test.scss
2 changes: 1 addition & 1 deletion .version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.9.1
1.10.0
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
=== HEAD

=== 1.10.0 (April 25, 2015)

- [Issue #108](https://github.com/chris-pearce/scally/issues/108) applied.

=== 1.9.1 (April 25, 2015)

- [Issue #96](https://github.com/chris-pearce/scally/issues/96) applied, thanks
Expand Down
22 changes: 9 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Scally is designed to be configurable, only requiring you to bring in the parts



# Demo's
# Demo's

*A website—featuring demos of everything in Scally—is coming soon, in the meantime they're CodePen's that can be looked at (work in progress):*

Expand Down Expand Up @@ -150,11 +150,9 @@ You can install Scally via the [**Download by zip**](https://github.com/chris-pe

## Setting up your master stylesheet

Once you have installed Scally you will need to create a master Sass stylesheet called `style.scss`, or whatever you want to name it, that will live in the root of the folder where you keep all of your CSS.
Once you have installed Scally you will need to create a master Sass stylesheet called `style.scss`, or whatever you want to name it, but for the purpose of this document `style.scss` will be the expected name. This file will live at the root of the folder where you keep all of your CSS.

Once you have created this file grab everything [from here](https://github.com/chris-pearce/scally/blob/master/style.scss) and paste it into your master stylesheet.

This master stylesheet is what you will link too from your HTML head, once compiled that is, you can run a basic Sass watch command to compile your Sass, like this:
This will be your master stylesheet and is what you will link too from your HTML head, once compiled that is, you can run a basic Sass watch command to compile your Sass, like this:

```
sass --watch style.scss:style.css
Expand All @@ -168,29 +166,27 @@ Then add a reference to the compiled master stylesheet in your HTML head:
<link href="[path/to/your/css/folder]/style.css" rel="stylesheet">
```

This master stylesheet is designed to pull in everything from Scally plus your project-specific styles and compile down to a single css file.

## Master stylesheet overview

Your master stylesheet is split into three main sections:

- [**Your settings.**](#your-settings) All of your project-specific settings in the form of Sass variables.
- [**Scally framework.**](#scally-framework) The entire Scally framework including your overrides.
- [**Your styles.**](#your-styles) All of the CSS you will write for your project.
1. [**Your settings.**](#your-settings) All of your project-specific settings in the form of Sass variables.
2. [**Scally framework.**](#scally-framework) The entire Scally framework including your overrides.
3. [**Your styles.**](#your-styles) All of the CSS you will write for your project.

**N.B.** it's imperative this order is maintained otherwise Scally won't work.

### Your settings

This first section consists of one Sass partial:
Create a new `.scss` file called `settings.scss` that will live in the root of the folder where you keep all of your CSS, along with your master Sass stylesheet: `style.scss`, and link to this file from `style.scss` like so:

```
@import "settings";
```

Which should live at the same level in your project file structure as your master stylesheet: `style.scss`, see an [example here](https://raw.githubusercontent.com/chris-pearce/scally/master/settings.scss).
**This must come before the other two sections.**

In this partial you will store all of your common project-specific settings, beyond what Scally offers. Typically you won't have many of these.
In this file you will store all of your common project-specific settings, beyond what Scally offers. Typically you won't have many of these.

Common project-specific settings might be adding more colours, so if you decide you need a new colour then in `settings.scss` you can create one like so:

Expand Down
14 changes: 5 additions & 9 deletions bower.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
{
"name": "scally",
"version": "1.9.1",
"version": "1.10.0",
"homepage": "https://github.com/chris-pearce/scally",
"main": "style.css",
"authors": [
"Chris Pearce <[email protected]>",
"Kate Levin <[email protected]>",
Expand All @@ -18,16 +17,13 @@
"bem",
"responsive"
],
"license": "The MIT License (MIT)",
"license": "Apache 2",
"ignore": [
".gitignore",
"settings.scss",
"style.scss",
"style-test.scss",
".npmignore",
"CHANGELOG.md",
"package.json",
"test.html",
".version",
".npmignore"
"test.scss",
"test.html"
]
}
5 changes: 2 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
{
"name": "scally",
"version": "1.9.1",
"version": "1.10.0",
"description": "Scally is a Sass, BEM, OOCSS, responsive ready, CSS framework that provides you with a solid foundation for building reusable UI's quickly",
"main": "style.css",
"homepage": "https://github.com/chris-pearce/scally",
"keywords": [
"scally",
Expand Down Expand Up @@ -42,7 +41,7 @@
"url": "https://github.com/chris-pearce/scally/issues"
},
"license": {
"type": "The MIT License (MIT)",
"type": "Apache 2",
"url": "https://github.com/chris-pearce/scally/blob/master/LICENSE"
}
}
8 changes: 0 additions & 8 deletions settings.scss

This file was deleted.

Loading

0 comments on commit 1deaf70

Please sign in to comment.