]> git.ipfire.org Git - thirdparty/foundation/foundation-sites.git/blame - README.md
Removing noInvert from _setHandlePos() (#11854)
[thirdparty/foundation/foundation-sites.git] / README.md
CommitLineData
739b0952
NC
1<p align="center">
2 <a href="http://foundation.zurb.com/">
afc13abd 3 <img src="https://user-images.githubusercontent.com/9939075/38782856-2a64a43e-40fa-11e8-89cd-e873af03b3c4.png" alt="Foundation for Sites 6" width="448px" style="max-width:100%;"/>
739b0952
NC
4 </a>
5</p>
6 
7 
8
9
10<p align="center">
11 <a href="https://foundation.zurb.com/sites/docs/installation.html"><b>Install</b></a>
12 | <a href="https://foundation.zurb.com/sites/docs">Documentation</a>
13 | <a href="https://github.com/zurb/foundation-sites/releases">Releases</a>
4ffab21f 14 | <a href="CONTRIBUTING.md">Contributing</a>
739b0952
NC
15</p>
16
17---
18
774be8e3 19
e625e07f 20[![Build Status](https://travis-ci.org/zurb/foundation-sites.svg?branch=develop)](https://travis-ci.org/zurb/foundation-sites)
739b0952
NC
21[![dependencies Status](https://david-dm.org/zurb/foundation-sites/status.svg)](https://david-dm.org/zurb/foundation-sites)
22[![devDependencies Status](https://david-dm.org/zurb/foundation-sites/dev-status.svg)](https://david-dm.org/zurb/foundation-sites?type=dev)
2b3d31a3
NC
23[![npm version](https://badge.fury.io/js/foundation-sites.svg)](https://badge.fury.io/js/foundation-sites)
24[![Bower version](https://badge.fury.io/bo/foundation-sites.svg)](https://badge.fury.io/bo/foundation-sites)
25[![Gem Version](https://badge.fury.io/rb/foundation-rails.svg)](https://badge.fury.io/rb/foundation-rails)
b3252acd 26[![jsDelivr Hits](https://data.jsdelivr.com/v1/package/npm/foundation-sites/badge?style=rounded)](https://www.jsdelivr.com/package/npm/foundation-sites)
2b3d31a3 27[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/zurb/foundation-sites?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
9413fe16 28
91532b74 29Foundation 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.
4d83c3de 30
739b0952 31---
8db804d9 32
739b0952 33## Run locally
8abd453f 34
739b0952 35### Documentation
774be8e3 36
739b0952 37To run the documentation locally on your machine, you need [Node.js](https://nodejs.org/en/) installed on your computer. (Your Node.js version must be **6.4.0** or higher). Run these commands to set up the documentation:
888cc710 38
91532b74 39```bash
739b0952 40# Install
91532b74 41git clone https://github.com/zurb/foundation-sites
27de0002 42cd foundation-sites
a572491c 43npm install
888cc710 44
739b0952
NC
45# Start the documentation
46npm start
47```
a9cee248 48
739b0952 49### Testing
1b4bf536
GK
50
51Foundation 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.
52
739b0952
NC
53Run tests with:
54```bash
55# Sass unit tests
56npm run test:sass
57# JavaScript unit tests
58npm run test:javascript:units
59# Visual tests
60npm run test:visual
61```
1b4bf536 62
e26ff95e
KB
63Testing Supported By<br/>
64<img width="160" src="http://foundation.zurb.com/sites/docs/assets/img/logos/browser-stack.svg" alt="BrowserStack"/>
65
91532b74
GK
66## Contributing
67
96c1b85a 68Check out [CONTRIBUTING.md](CONTRIBUTING.md) to see how to report an issue or submit a bug fix or a new feature, and our [contributing guide](http://foundation.zurb.com/develop/contribute.html) to learn how you can contribute more globally 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.
c2959e52 69
739b0952
NC
70## Training
71
7516d9a4 72Want the guided tour to Foundation from the team that built it? The ZURB team offers comprehensive training courses for developers of all skill levels. If you're new to Foundation, check out the [Introduction to Foundation Course](http://zurb.com/university/foundation-intro?utm_source=Github%20Repo&utm_medium=website&utm_campaign=readme&utm_content=readme%20training%20link) to kickstart your skills, amplify your productivity, and get a comprehensive overview of everything Foundation has to offer. More advanced users should check out the [Advanced Foundation Course](http://zurb.com/university/advanced-foundation-training?utm_source=Github%20Repo&utm_medium=website&utm_campaign=readme&utm_content=readme%20training%20link) to learn the Advanced skills that ZURB uses to deliver quality client work in short timeframes.
739b0952 73
cc516098 74Copyright © 2019 ZURB, Inc.