From: Caleb Winters Date: Fri, 9 May 2014 18:27:32 +0000 (-0700) Subject: update readme X-Git-Url: http://cvs2.gaslightmedia.com/gitweb/?a=commitdiff_plain;h=b160d5611935a77065303e93d31cf6697fd2ea96;p=web%2FFoundationZurbProject.git update readme --- diff --git a/README.md b/README.md index 5641654..fc06708 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,36 @@ -# Foundation libsass template +# The Perfect Foundation Stack -This is a template to start your own project that uses Grunt and libsass! +This is a template for your next web project using Foundation, Grunt, Libsass, and Assemble! ## Requirements You'll need to have the following items installed before continuing. * [Node.js](http://nodejs.org): Use the installer provided on the NodeJS website. - * [Grunt](http://gruntjs.com/): Run `[sudo] npm install -g grunt-cli` - * [Bower](http://bower.io): Run `[sudo] npm install -g bower` + * [Grunt](http://gruntjs.com/): Run `sudo npm install -g grunt-cli` + * [Bower](http://bower.io): Run `sudo npm install -g bower` ## Quickstart -```bash -git clone git@github.com:zurb/foundation-libsass-template.git -npm install && bower install -``` +Clone this repository: +`git clone git@github.com:zurb/foundation-libsass-template.git` + +Navigate into the directory: +`cd foundation-libsass-template` + +Install all the dependincies: +`npm install && bower install` While you're working on your project, run: `grunt` -And you're set! +This will assemble all the pages and compile the Sass. You're set! ## Directory Structure - * `scss/_settings.scss`: Foundation configuration settings go in here - * `scss/app.scss`: Application styles go here +* `dist`: Static pages are assembled here. This is where you should view the site in your browser. **Don't edit these files directly. They will be overwritten!** +* `src`: This is the directory you'll work in. +* `src/assets`: All assets (scss, images, fonts, js, etc) go here. +* `src/assets/scss/_settings.scss`: Foundation configuration settings go in here +* `src/assets/scss/app.scss`: Application styles go here \ No newline at end of file