Additional details to supplement the brief nature of the README file. ## Table of contents * [Using Fuel UX](#using-fuel-ux) * [Downloading code](#downloading-code) * [AMD support](#amd-support) * [Compiling code](#compiling-code) * [Running docs locally](#running-docs-locally) * [Contributors](#contributors) * [Travis CI](#travis-ci) ## Using Fuel UX Fuel UX can be applied to a section of your your HTML or the entire page by adding the `fuelux` wrapper class (eg. [checkbox](http://getfuelux.com/javascript.html#checkbox)): ```html
``` ## Downloading code Fuel UX can be obtained in any of the following ways: * Request files from [the Fuel UX CDN](http://www.fuelcdn.com/fuelux/3.6.4/) * Using [Bower](https://github.com/bower/bower) (ensures you get all the [dependencies](#dependencies)): ``` bower install fuelux ``` Update with `bower update fuelux`. * Using [Volo](https://github.com/volojs/volo) (ensures you get all the [dependencies](#dependencies)): ``` volo add fuelux ``` Update with `volo add -f fuelux`. * Clone the Git repository: ``` git clone https://github.com/ExactTarget/fuelux/ ``` Cloning the repository ensures you can apply future updates to Fuel UX easily, but requires to you manage its [dependencies](#dependencies) on your own. * Download a .zip archive of the [latest release](http://www.fuelcdn.com/fuelux/3.6.4/fuelux.zip). ## AMD support We recommend only loading the controls you need (eg `fuelux/checkbox`). If using AMD (such as [RequireJS](http://requirejs.org)), reference the FuelUX directory in your paths configuration, wherever it is located: ```javascript require.config({ paths: { 'fuelux': 'http://www.fuelcdn.com/fuelux/3.6.4/' //... } }); ``` Then list any individual fuel ux controls needed as dependencies within your application modules: ```javascript define(function(require) { var spinbox = require('fuelux/spinbox'); //... }); ``` In instances where you require every module from Fuel UX, you can use `fuelux/all` instead of listing each module individually. Fuel UX also supports placing components in their own `