readme.md

   1 # Welcome to jQuery Mobile Boilerplate
   2
   3 "What do I need in a new jQuery Mobile project?". This project is meant to be a single place for developers to get started using jQuery Mobile. It includes icon files, robots.txt (and human).txt files, as well as an extensive snippets library that developers can use as reference.
   4
   5 **Note:** The jQuery team has offered two options for CSS file inclusion. If you're planning on using a custom theme then you only need to include `jquery.mobile.structure-1.1.0.min.css`.
   6
   7 ## Quick start
   8
   9 Clone the git repo - `git clone git@github.com:commadelimited/jQuery-Mobile-Boilerplate.git` - or [download it](https://github.com/commadelimited/jQuery-Mobile-Boilerplate/zipball/master)
  10
  11 **Note:** By default, the links to the CSS and JS files are root relative. This means that Boilerplate expects to be placed in the root of your website. If this is not the configuration you're using then you'll need to update these links manually.
  12
  13 ## Example
  14
  15 [View a simple demo ](http://andymatthews.net/code/jquery-mobile-boilerplate/)
  16
  17 ## Features
  18
  19 * jQuery Mobile 1.1 Final Compatible!
  20 * Project ready. Download (or clone) and go!
  21 * The latest jQuery Mobile JS & CSS bits from CDN, with a local option.
  22 * The latest jQuery bits from CDN, with a local option.
  23 * Override files for both JS and CSS
  24 * Extensive UI element snippet library. Easy to copy and paste.
  25 * Includes Scott Jehl's fix for the [iOS orientation bug](https://github.com/scottjehl/iOS-Orientationchange-Fix)
  26
  27 ## Contributing
  28
  29 You are invited to contribute code and suggestions to this project. The more the merrier.
  30
  31 ## Project Info
  32
  33 * Source: http://github.com/commadelimited/jQuery-Mobile-Boilerplate
  34 * Twitter: [http://twitter.com/jqmbp](http://twitter.com/jqmbp)
  35 * Twitter: [http://twitter.com/commadelimited](http://twitter.com/commadelimited)
  36
  37 ## License
  38
  39 ### 3rd party libraries:
  40
  41 * jQuery: MIT/GPL license
  42 * jQuery Mobile: MIT/GPL license
  43
  44 ### Custom bits:
  45
  46 Public domain