45 lines
3 KiB
Markdown
45 lines
3 KiB
Markdown
|
# [Foundation for Sites](http://foundation.zurb.com)
|
||
|
|
|
||
|
|
[](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)
|
||
|
|
|
||
|
|
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 a fully customizable, responsive grid, a large library of Sass mixins, commonly used JavaScript plugins, and full accessibility support.
|
||
|
|
|
||
|
|
## Getting Started
|
||
|
|
|
||
|
|
The quickest way to get started is with the [basic CSS download](http://foundation.zurb.com/sites/download/). You can get versions with every component, essential ones only, or a custom build.
|
||
|
|
|
||
|
|
If you're a Sass user, we have two starter project templates, the [Basic Template](https://github.com/zurb/foundation-sites-template) and the [ZURB Template](https://github.com/zurb/foundation-zurb-template). You can install them by manually downloading them from GitHub, or using the [Foundation CLI](https://github.com/zurb/foundation-cli).
|
||
|
|
|
||
|
|
Lastly, if you're rolling your own setup, you can install Foundation through a variety of [package managers](http://foundation.zurb.com/sites/docs/installation.html#package-managers).
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
|
||
|
|
The documentation can be found at <https://foundation.zurb.com/sites/docs>. To run the documentation locally on your machine, you need [Node.js](https://nodejs.org/en/) and [Ruby](https://www.ruby-lang.org/en/) installed on your computer. (Your Node.js version must be 0.12 or higher.)
|
||
|
|
|
||
|
|
Run these commands to set up the documentation:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
git clone https://github.com/zurb/foundation-sites
|
||
|
|
cd foundation-sites
|
||
|
|
gem install scss-lint
|
||
|
|
npm install
|
||
|
|
```
|
||
|
|
|
||
|
|
Then run `npm start` to compile the documentation. When it finishes, a new browser window will open pointing to a BrowserSync server displaying the documentation.
|
||
|
|
|
||
|
|
## Testing
|
||
|
|
|
||
|
|
Foundation has three kinds of tests: JavaScript, Sass, and visual regression. Refer to our [testing guide](https://github.com/zurb/foundation-sites/wiki/Testing-Guide) for more details.
|
||
|
|
|
||
|
|
These commands will run the various tests:
|
||
|
|
|
||
|
|
- `npm run test:sass`
|
||
|
|
- `npm run test:javascript`
|
||
|
|
- `npm run test:visual`
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
Check out our [contributing guide](http://foundation.zurb.com/develop/contribute.html) to learn how you can contribute to Foundation. You can also browse the [Help Wanted](https://github.com/zurb/foundation-sites/labels/help%20wanted) tag in our issue tracker to find things to do.
|
||
|
|
|
||
|
|
Copyright (c) 2016 ZURB, inc.
|