Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Tree: d2b73e18f7
Fetching contributors…

Cannot retrieve contributors at this time

136 lines (93 sloc) 4.603 kB

PhoneGap

PhoneGap is a development tool that allows web developers to take advantage of the core features in the iPhone, Android, BlackBerry, and Symbian with a unified JavaScript API.

Get Started

Get the source.

git clone git://github.com/phonegap/phonegap.git

PhoneGap project is separated into git submodules for each device.

phonegap
  |- README.md
  |- android/
  |- blackberry/
  |- iphone/
  |- symbian.wrt/
  `- winmo/ (not production ready)

Each project has a respective README.md file. view that file for detailed information on how to work with that device. PhoneGap offers one unified API for accessing core functionality on all devices. Where possible, phonegap follows the HTML5 spec.

Getting the Submodules

  1. Launch "Terminal.app" and navigate to the phonegap folder (this folder)
  2. Type in "git submodule init" and press Enter
  3. Type in "git submodule update" and press Enter

Updating a Submodule

The submodules only get the code at a certain commit, when initially added. From time to time, we will update this commit pointer. To manually update to the latest code:

  1. Launch "Terminal.app" and navigate to the submodule folder
  2. Type in "git remote update" and press Enter
  3. Type in "git merge origin/master" and press Enter

API

Device

Exposes properties of the phone, such as its device ID, model, and OS version number.

Location

Gain access to the Latitude / Longitude of the device, and depending on the type of device, the course, speed, and altitude.

Accelerometer

Monitor the accelerometer on the device to detect orientation, shaking and other similar actions.

Contacts

Query the phone addressbook to read the users contacts.

Orientation

Read the device layout orientation, e.g. landscape vs portrait.

Camera

Brings up the camera or photo browser on the phone to allow the user to upload a photo.

Vibrate

Triggers the vibration alert on the phone, if it is supported.

Sound

Play sound files (WAV, MP3, etc).

Telephony

Trigger and activate phone calls.

XUI

You may work with any Javascript framework within a PhoneGap application. XUI is the "officially preferred" framework of the phonegap core team. XUI is inspired by JQuery, optimized for web browsers and weighs in at 2.4k (minified and gziped).

Community

Contribute

Fork, commit, push, and send us a pull request at phonegap/phonegap.

The MIT License

Copyright (c) 2008, 2009, 2010 Rob Ellis, Brock Whitten, Brian Leroux, Joe Bowser, Dave Johnson, Shazron Abdullah, Jesse MacFadyen, Filip Maj, Ryan Willoughby, Nitobi

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Jump to Line
Something went wrong with that request. Please try again.