Merge pull request #2 from CastleCSS/release/1.0

Release/1.0

Author: amberjasmijn

.gitignore

@@ -0,0 +1,4 @@
+*.log
+thumbs.db
+
+node_modules

Gruntfile.js

@@ -0,0 +1,75 @@
+/*	Grunt Task configuration */
+module.exports = function(grunt) {
+
+	/* Using jit-grunt for automatically loading all required plugins */
+	require('jit-grunt')(grunt);
+
+	grunt.initConfig({
+		pkg: grunt.file.readJSON('package.json'),
+
+		// Compile Sass to CSS and produce SoureMaps;
+		sass: {
+			options: {
+				sourceMap: false,
+				outputStyle: 'uncompressed'
+			},
+			files: {
+				src: 'scss/main.scss',
+				dest: 'dist/css/styles.min.css',
+				ext: '.css'
+			}
+		},
+
+		// PostCSS for adding prefixers and setting rem to pixel
+		postcss: {
+			dist: {
+				src: 'dist/css/styles.min.css'
+			},
+			options: {
+				// Rewrite and save sourcemap as seperate file
+				map: {
+					inline: false,
+					annotation: 'styles/'
+				},
+				processors: [
+					// Add fallbacks for rem units
+					require('pixrem')({
+						atrules: true
+					}),
+					// Add vendor prefixes
+					require('autoprefixer')({
+						browsers: 'iOS >= 7, last 2 versions, ie > 7'
+					}),
+					// Minify the result
+					require('cssnano')()
+				]
+			}
+		},
+
+		// Watches for changes in your .scss-files and triggers the tasks sass and postcss.
+		watch: {
+			files: 'scss/**/*.scss',
+			tasks: ['sass', 'postcss'],
+			options: {
+				spawn: false,
+			}
+		}
+	})
+
+	// Grunt Tasks
+	// Run these by typing 'grunt' or 'grunt <command>' in your terminal.
+	grunt.registerTask('default', 'run');
+	grunt.registerTask('run',
+		[
+			'sass',
+			'postcss',
+			'watch'
+		]
+	);
+	grunt.registerTask('create_css',
+		[
+			'sass',
+			'postcss'
+		]
+	);
+};

README.md

@@ -0,0 +1,74 @@
+# CastleCSS Boilerplate
+[CastleCSS](https://github.com/CastleCSS/) is a modular, updatable and easy to use HTML and SCSS framework.
+Use this Boilerplate to get started with your project right away!
+
+![CastleCSS logo @CastleCss.com](https://www.doordarius.nl/castlecss-logo-250.png)
+
+## What's included?
+- A simple and mobile-friendly HTML5 template to kickstart your website
+- Configuration for Grunt, to easily compile and minify your Sass files
+- [castlecss-core](https://github.com/CastleCSS/castlecss-core)
+- [castlecss-buttons](https://github.com/CastleCSS/castlecss-buttons)
+- [castlecss-notifications](https://github.com/CastleCSS/castlecss-notifications)
+
+## Get started
+1. Clone ```git clone https://github.com/CastleCSS/castlecss.git``` or [download](https://github.com/CastleCSS/castlecss-boilerplate/archive/master.zip) CastleCSS Boilerplate.
+2. Set up your project directory and a basic site structure.
+3. Run Grunt from your directory by typing ```Grunt``` in the commandline. If you haven't used Grunt before, be sure to check out the Getting Started guide.
+4. Add some content, do some styling and include functionality.
+5. Run your site locally and see how it all works out!
+
+## Basic structure
+The basis structure for your website should look similar like this:
+
+```
+| Project directory/
+|
+|-- node_modules/
+| | -- castlecss-core/
+| | --castlecss-buttons/
+| | --castlecss-notifications/
+| |
+|-- scss/
+| |-- main.scss
+| |-- variables.scss
+| |
+|-- img/
+|-- dist/
+| |-- styles.min.css
+| |-- styles.min.map
+| |
+|-- index.html
+|-- Gruntfile.js
+|-- package.json
+```
+
+### main.scss
+Your main.scss should have the following set-up:
+
+```
+/* 	CastleCSS Core variables */
+@import "node_modules/castlecss-core/sass/variables";
+
+/* 	Your variables */
+@import "variables";
+
+/* 	Remaining Core files and other CastleCSS modules */
+@import "node_modules/castlecss-core/sass/main";
+@import "node_modules/castlecss-buttons/sass/main";
+@import "node_modules/castlecss-notifications/sass/main";
+
+/* Include your own files below this line
+   -------------------------------------- */
+
+
+
+/* --------------------------------------
+   Include your own files above this line */
+
+@import "node_modules/castlecss-core/sass/base/utility";
+@import "node_modules/castlecss-core/sass/base/utility_spacers";
+```
+
+## Documentation and examples
+Check out http://www.castlecss.com for an extended documentation and more examples!

clean.html

@@ -0,0 +1,46 @@
+<!DOCTYPE html>
+<html>
+<head>
+	<!-- Basic Page Needs -->
+	<meta charset="utf-8">
+	<title>Your page title - CastleCSS Clean Boilerplate</title>
+	<meta name="description" content="">
+	<meta name="author" content="">
+
+	<!-- Mobile Specific Metas -->
+	<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no, maximum-scale=1" />
+
+	<!-- Fonts -->
+	<link href="https://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet">
+
+	<!-- CSS -->
+	<link rel="stylesheet" href="dist/css/styles.min.css" />
+
+	<!-- Favicon -->
+	<link rel="icon" type="image/png" href="img/favicon.png">
+</head>
+<body>
+	<div class="wrapper">
+		<div class="header">
+		</div>
+		<section class="p">
+			<div class="container">
+				<div class="g">
+					<div class="b0_12">
+						<h1>Basic Page</h1>
+						<p>
+							This clean.html page is a placeholder with the CSS, font and favicon. Let's add some content!
+						</p>
+						<p>
+							Need help setting things up? Check out the <a href="index.html" target="_blank">CastleCSS examples and layout</a> included in this package to speed things up a bit.
+						</p>
+						<p>
+							Or take a look at the documentation over at <a href="http://www.castlecss.com" target="_blank">www.castlecss.com</a>.
+						</p>
+					</div>
+				</div>
+			</div>
+		</section>
+	</div>
+</body>
+</html>