-# [Foundation](http://foundation.zurb.com)
+# [Foundation for Sites](http://foundation.zurb.com) (Public Beta)
-[](https://travis-ci.org/zurb/foundation)
+This is the in-development version of Foundation for Sites 6.0.
+[](https://gitter.im/zurb/foundation-sites-6?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
-Foundation is the most advanced responsive front-end framework in the world. You can quickly prototype and build sites or apps that work on any kind of device with Foundation, which includes layout constructs (like a fully responsive grid), elements and best practices.
+## Requirements
-To get started, check out <http://foundation.zurb.com/docs>
+Requires NodeJS to be installed on your machine. Works with 0.10, 0.12, and 4.1! **Note that parts of our build process will break with NPM 3, due to the changes in how packages are installed.**
+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/).
-## Quickstart
+## Setup
- ```bash
- git clone https://github.com/zurb/foundation-sites-6.git
- cd foundation-sites-6
+ To get going with Foundation you can:
+
+ * [Download the latest release](http://foundation.zurb.com/develop/download.html)
+ * [Install with Bower](http://bower.io): `bower install foundation`
+ * [Install with npm](http://npmjs.com): `npm install foundation-sites`
+
+ ## Documentation
+
+ Foundation uses [Assemble.io](http://assemble.io) and [Grunt](http://gruntjs.com/) to generate its [documentation pages](http://foundation.zurb.com/docs). Documentation can also be run from your local computer:
+
+ ### View documentation locally
+
+ You'll want to clone the Foundation repo first and install all the dependencies. You can do this using the following commands:
+
+ ```
+ git clone git@github.com:zurb/foundation.git
+ cd foundation
+ npm install -g grunt-cli bower
npm install
- npm start
+ bower install
+ bundle install
+ ```
+
+ Then just run `grunt build` and the documentation will be compiled:
+
+ ```
+ foundation/
+ ├── dist/
+ │ └── ...
+ ├────── docs/
+ │ └── ...
```
- ## Local Testing
-
- `npm start` will compile the documentation. For this testing period, we've created a small testbed to experiment with components. You can find the assets under the `testing/` folder. To use the testbed, run `npm run testbed` after installing the needed dependencies.
-
- ## Folder structure
-
- - `_build/`: compiled HTML, CSS, and JavaScript. *Don't edit these files directly, as they will be overwritten!*
- - `config/`: configuration files for our linters.
- - `dist/`: compiled CSS and JavaScript files for the current release.
- - `docs/`: documentation source.
- - `layouts/default.html`: base HTML template for every docs page.
- - `layouts/component.html`: Handlebars template for component documentation.
- - `pages/*.html`: basic documentation pages.
- - `pages/*.md`: fancy documentation pages for components, which are parsed through [Supercollider](https://github.com/gakimball/supercollider).
- - `partials/`: Handlebars partials go here.
- - `assets/`: docs-specific images, styles, and scripts go here.
- - `js/`: the Foundation 5 JavaScript.
- - New components are inside this folder.
- - Old components are in `js/foundation/`.
- - `scss/`: the Sass.
- - `scss/components`: new UI components go here.
- - `scss/components_old`: Foundation 5 components stay here.
- - `scss/forms`: form styles.
- - `scss/grid`: the new grid.
- - `scss/typography`: typography.
- - `scss/util`: helper functions and mixins.
- - `scss/vendor`: third-party libraries.
- - `_global.scss`: global variables and styles.
- - `docs_old/`: Foundation 5 documentation.
- - `spec/`: Foundation 5 unit tests.
+ Copyright (c) 2015 ZURB, inc.
{
"name": "foundation-sites",
++<<<<<<< HEAD
+ "version": "6.0.0-alpha.2",
+ "main": "js/foundation/foundation.js",
+ "scripts": {
+ "start": "gulp",
+ "test": "gulp test",
+ "testbed": "cd testing && gulp",
+ "deploy": "gulp deploy:docs"
+ },
+ "dependencies": {
+ "jquery": "^2.1.0",
+ "what-input": "^1.1.2"
+ },
+ "devDependencies": {
+ "bootcamp": "^1.1.7",
+ "browser-sync": "^2.8.2",
+ "gulp": "^3.8.10",
+ "gulp-autoprefixer": "^2.3.1",
+ "gulp-cached": "^1.0.4",
+ "gulp-concat": "^2.4.3",
+ "gulp-filter": "^2.0.2",
+ "gulp-jshint": "^1.9.2",
+ "gulp-load-plugins": "^0.8.0",
+ "gulp-minify-css": "^1.2.1",
+ "gulp-plumber": "^1.0.1",
+ "gulp-prompt": "^0.1.2",
+ "gulp-rename": "^1.2.2",
+ "gulp-rsync": "0.0.5",
+ "gulp-ruby-sass": "^1.0.0-alpha.3",
+ "gulp-sass": "^2.1.0",
+ "gulp-scss-lint": "^0.2.2",
+ "gulp-uglify": "^1.1.0",
+ "handlebars": "^3.0.1",
+ "highlight.js": "^8.5.0",
+ "marked": "^0.3.3",
+ "mocha": "^2.3.3",
+ "motion-ui": "^1.1.0",
+ "multiline": "^1.0.2",
+ "octophant": "^1.0.0",
+ "open": "0.0.5",
+ "opener": "^1.4.1",
+ "panini": "^1.0.0",
+ "parker": "0.0.9",
+ "pretty-print": "^1.0.0",
+ "prettyjson": "^1.1.3",
+ "require-dir": "^0.3.0",
+ "rimraf": "^2.3.2",
+ "run-sequence": "^1.1.4",
+ "string-template": "^0.2.1",
+ "supercollider": "^1.0.0",
+ "typeahead.js": "^0.11.1",
+ "zeroclipboard": "^2.2.0"
++=======
+ "version": "5.5.3",
+ "main": "js/foundation/foundation.js",
+ "scripts": {
+ "start": "grunt"
+ },
+ "devDependencies": {
+ "assemble": "~0.4.37",
+ "grunt": "~0.4.4",
+ "grunt-cli": "^0.1.13",
+ "grunt-contrib-clean": "~0.5.0",
+ "grunt-contrib-compress": "~0.7.0",
+ "grunt-contrib-concat": "~0.3.0",
+ "grunt-contrib-connect": "~0.7.1",
+ "grunt-contrib-copy": "~0.5.0",
+ "grunt-contrib-cssmin": "^0.12.2",
+ "grunt-contrib-jasmine": "~0.6.3",
+ "grunt-contrib-jst": "~0.5.1",
+ "grunt-contrib-sass": "~0.8.1",
+ "grunt-contrib-uglify": "~0.4.0",
+ "grunt-contrib-watch": "~0.6.1",
+ "grunt-karma": "~0.6.2",
+ "grunt-newer": "~0.7.0",
+ "grunt-rsync": "~0.2.1",
+ "grunt-string-replace": "~0.2.7",
+ "handlebars-helper-rel": "~0.1.2",
+ "handlebars-helper-slugify": "~0.2.0",
+ "highlight.js": "~7.3.0",
+ "jasmine-jquery": "imtapps/node-jasmine-jquery",
+ "karma": "~0.10.4",
+ "karma-browserstack-launcher": "0.0.4",
+ "karma-chrome-launcher": "~0.1.0",
+ "karma-firefox-launcher": "~0.1.0",
+ "karma-html2js-preprocessor": "~0.1.0",
+ "karma-ie-launcher": "~0.1.1",
+ "karma-jasmine": "~0.1.3",
+ "karma-phantomjs-launcher": "~0.1.0",
+ "karma-safari-launcher": "~0.1.1",
+ "karma-script-launcher": "~0.1.0",
+ "load-grunt-config": "~0.16.0"
++>>>>>>> master
},
"repository": {
"type": "git",
projects / thirdparty / foundation / foundation-sites.git / commitdiff
