git.roojs.org Git - ratchet/blob - README.md

   1 # Ratchet
   2
   3 Prototype mobile apps with simple HTML, CSS and JS components.
   4
   5 ## Getting Started
   6
   7 - Clone the repo `git clone git@github.com:maker/ratchet.git` or just [download](http://maker.github.com/ratchet/ratchet.zip) the bundled CSS and JS
   8 - [Read the docs](http://maker.github.com/ratchet) to learn about the components and how to get a prototype on your phone
   9 - We will have example apps to check out very soon!
  10
  11 Take note that our master branch is our active, unstable development branch and that if you're looking to download a stable copy of the repo, check the [tagged downloads](https://github.com/maker/ratchet/tags).
  12
  13 ## Support
  14
  15 Ratchet was developed to support iOS 5+ for iPhone. Questions or discussions about Ratchet should happen in the [Google group](https://groups.google.com/forum/#!forum/goratchet) or hit us up on Twitter [@goRatchet](http://www.twitter.com/goratchet).
  16
  17 ## Reporting bugs & contributing
  18
  19 Please file a Github issue to [report a bug](http://github.com/maker/ratchet/issues). When reporting a bug, be sure to follow the [contributor guidelines](https://github.com/maker/ratchet/blob/master/CONTRIBUTING.md).
  20
  21 ## Troubleshooting
  22
  23 A small list of "gotchas" are provided below for developers starting to work with Ratchet
  24
  25 - Ratchet is designed to respond to touch events from a mobile device. In order to use mouse click events (for desktop browsing and testing), you have a few options:
  26     - Enable touch event emulation in Chrome (found in the overrides tab in the web inspector preferences)
  27     - Use a javascript library like fingerblast.js to emulate touch events (depending on the user agent)
  28 - Script tags containing javascript will not be executed on pages that are loaded with push.js. If you would like to attach event handlers to elements on other pages, document-level event delegation is a common solution.
  29
  30 ## Future features
  31
  32 Ratchet is just getting started. Here are some of the immediate features we're thinking about:
  33
  34 - Shelf (exposable left hand navigation a la Path or Facebook)
  35 - Gridviews
  36 - Notifications
  37 - Slide control
  38 - More list views options
  39 - Improved active states (especially for lists)
  40 - Docking list dividers
  41 - Touch library for richer touch events (swipes, long press, etc)
  42 - Autocomplete
  43 - Hiding title bar (hides with scroll)
  44
  45 Even these are just the short-term goals though. We eventually want to extend Ratchet beyond the prototying for iPhone and create HTML/CSS/JS components for iPad and Android devices. Our dream is that Ratchet becomes the best way to create mobile experiences with web standard languages.
  46
  47 ## Authors
  48
  49 Dave Gamache
  50
  51 - http://twitter.com/dhg
  52 - http://github.com/dhgamache
  53
  54 Connor Sears
  55
  56 - http://twitter.com/connors
  57 - http://github.com/connors
  58
  59 Jacob Thornton
  60
  61 - http://twitter.com/fat
  62 - http://github.com/fat
  63
  64
  65 ## License
  66
  67 Ratchet is licensed under the [MIT License](http://opensource.org/licenses/MIT).