|
| 1 | +# [Foundation for Sites](http://foundation.zurb.com) (v6.1) |
| 2 | + |
| 3 | +[](https://badge.fury.io/js/foundation-sites) [](https://badge.fury.io/bo/foundation-sites) [](https://badge.fury.io/rb/foundation-rails) [](https://david-dm.org/zurb/foundation-sites#info=devDependencies) [](https://gitter.im/zurb/foundation-sites?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) |
| 4 | + |
| 5 | +Foundation is the most advanced responsive front-end framework in the world. Quickly go from prototype to production, building sites or apps that work on any kind of device with Foundation. Includes layout constructs, like a fully customizable, responsive grid, commonly used JavaScript plugins, and full A11Y support. |
| 6 | + |
| 7 | +## Requirements |
| 8 | + |
| 9 | +Requires NodeJS to be installed on your machine. Works with version 0.12 and higher! |
| 10 | + |
| 11 | +The Sass is compiled using libsass, which requires the GCC to be installed on your machine. Windows users can install it through [MinGW](http://www.mingw.org/), and Mac users can install it through the [Xcode Command-line Tools](http://osxdaily.com/2014/02/12/install-command-line-tools-mac-os-x/). |
| 12 | + |
| 13 | +## Setup |
| 14 | + |
| 15 | +To get going with Foundation you can: |
| 16 | + |
| 17 | + |
| 18 | + * [Install Yeti Launch](http://foundation.zurb.com/develop/yeti-launch.html): Seriously though, check it out! |
| 19 | + * [Install the CLI](https://www.npmjs.com/package/foundation-cli): `npm install -g foundation-cli` |
| 20 | + * [Download the latest release](http://foundation.zurb.com/sites/download.html) |
| 21 | + * [Install with Bower](http://bower.io): `bower install foundation-sites` |
| 22 | + * [Install with npm](http://npmjs.com): `npm install foundation-sites` |
| 23 | + * [Install with Atmosphere for Meteor](https://atmospherejs.com): `meteor add zurb:foundation-sites` |
| 24 | + * [Install with Composer](https://getcomposer.org/): `php composer.phar require zurb/foundation` |
| 25 | + |
| 26 | +## Documentation |
| 27 | + |
| 28 | +Foundation uses [Gulp](http://gulpjs.com/) and [SuperCollider](https://www.npmjs.com/package/supercollider) to generate its [documentation pages](http://foundation.zurb.com/sites/docs). Documentation can also be run from your local computer: |
| 29 | + |
| 30 | +### View documentation locally |
| 31 | + |
| 32 | +You'll want to clone the Foundation repo first and install all the dependencies. You can do this using the following commands: |
| 33 | + |
| 34 | +``` |
| 35 | +git clone git@github.com:zurb/foundation-sites.git |
| 36 | +cd foundation-sites |
| 37 | +npm install |
| 38 | +``` |
| 39 | + |
| 40 | +Then just run `npm start` and the documentation will be compiled. It will also launch an instance of [BrowserSync](http://www.browsersync.io/) and open a tab in your default browser. |
| 41 | +The file structure: |
| 42 | + |
| 43 | +``` |
| 44 | +foundation/ |
| 45 | +├── dist/ |
| 46 | +│ └── ... |
| 47 | +├── docs/ |
| 48 | +│ └── ... |
| 49 | +``` |
| 50 | + |
| 51 | +Copyright (c) 2016 ZURB, inc. |
0 commit comments