cordova-android/README.md

Cordova Android
===

Cordova Android is an Android application library that allows for Cordova based projects to be built for the Android Platform. Cordova based applications are, at the core, an application written with web technology: HTML, CSS and JavaScript. 

Apache Cordova is an effort undergoing incubation at The Apache
Software Foundation (ASF), sponsored by the Apache Incubator project.
Incubation is required of all newly accepted projects until a further
review indicates that the infrastructure, communications, and decision
making process have stabilized in a manner consistent with other
successful ASF projects. While incubation status is not necessarily
a reflection of the completeness or stability of the code, it does
indicate that the project has yet to be fully endorsed by the ASF.

Requires
---

- Java JDK 1.5
- Apache ANT
- Android SDK [http://developer.android.com](http://developer.android.com)
- Apache Commons Codec [http://commons.apache.org/codec/](http://commons.apache.org/codec/)

Test Requirements
---
- JUnit - [https://github.com/KentBeck/junit](https://github.com/KentBeck/junit)
 
Building
---

To create your cordova.jar, copy the commons codec:

    mv commons-codec-1.6.jar framework/libs

then run in the framework directory:

    android update project -p . -t android-16
    ant jar


Cordova Android Developer Tools
---

The Cordova developer tooling is split between general tooling and project level tooling. 

To enable the command-line tools available in the ./bin directory, make
sure you have all of the dependencies installed. You will need
[NodeJS](http://nodejs.org) (which should come with `npm`). To install
the dependencies:

    $ cd bin
    $ npm install

General Commands

    ./bin/create [path package activity] ... create the ./example app or a cordova android project
    ./bin/bench ............................ generate a bench proj
    ./bin/autotest ......................... test the cli tools
    ./bin/test ............................. run mobile-spec

Project Commands

These commands live in a generated Cordova Android project.

    ./cordova/debug [path] ..................... install to first device
    ./cordova/emulate .......................... start avd (emulator) named default
    ./cordova/log .............................. starts logcat

Running the Example Project
---

Start avd (emulator) named `default`:

    ./bin/emulate

Create the example project and build it to the first device:

    ./bin/create
    cd example
    ./cordova/debug

Start adb logcat (console.log calls output here):

    ./cordova/log

Creating a new Cordova Android Project
---

    ./bin/create ~/Desktop/myapp com.myapp.special MyApp

Importing a Cordova Android Project into Eclipse
----

1. File > New > Project...
2. Android > Android Project
3. Create project from existing source (point to the generated app found in tmp/android)
4. Right click on libs/cordova.jar and add to build path
5. Right click on the project root: Run as > Run Configurations
6. Click on the Target tab and select Manual (this way you can choose the emulator or device to build to)

Running Tests
----
Please see details under test/README.md.

Further Reading
---

- [http://developer.android.com](http://developer.android.com)
- [http://incubator.apache.org/cordova/](http://incubator.apache.org/cordova/)
- [http://wiki.apache.org/cordova/](http://wiki.apache.org/cordova/)
README.md: Replace "PhoneGap" with "Cordova" and add incubation disclaimer (This is a test commit to for checking the git push problem by Bryce) 2012-01-06 04:33:26 +08:00			`Cordova Android`
no more ruby dependency 2011-08-19 09:21:51 +08:00			`===`

README.md: Replace "PhoneGap" with "Cordova" and add incubation disclaimer (This is a test commit to for checking the git push problem by Bryce) 2012-01-06 04:33:26 +08:00			`Cordova Android is an Android application library that allows for Cordova based projects to be built for the Android Platform. Cordova based applications are, at the core, an application written with web technology: HTML, CSS and JavaScript.`

			`Apache Cordova is an effort undergoing incubation at The Apache`
Minor incubation disclaimer fix. 2012-01-06 04:39:18 +08:00			`Software Foundation (ASF), sponsored by the Apache Incubator project.`
README.md: Replace "PhoneGap" with "Cordova" and add incubation disclaimer (This is a test commit to for checking the git push problem by Bryce) 2012-01-06 04:33:26 +08:00			`Incubation is required of all newly accepted projects until a further`
			`review indicates that the infrastructure, communications, and decision`
			`making process have stabilized in a manner consistent with other`
			`successful ASF projects. While incubation status is not necessarily`
			`a reflection of the completeness or stability of the code, it does`
			`indicate that the project has yet to be fully endorsed by the ASF.`
Adding README 2009-11-25 07:11:32 +08:00
updated the improved cli docs 2011-08-20 13:20:53 +08:00			`Requires`
no more ruby dependency 2011-08-19 09:21:51 +08:00			`---`

sweet one line building! 2010-01-28 07:00:21 +08:00			`- Java JDK 1.5`
			`- Apache ANT`
updated the improved cli docs 2011-08-20 13:20:53 +08:00			`- Android SDK [http://developer.android.com](http://developer.android.com)`
Updating README telling people to copy commons-codec 2012-05-08 06:52:34 +08:00			`- Apache Commons Codec [http://commons.apache.org/codec/](http://commons.apache.org/codec/)`
documentation additions 2012-01-18 05:31:08 +08:00
Removing the hacked-up jars that I used to get this to work, since I can't distribute them 2012-05-08 07:30:24 +08:00			`Test Requirements`
			`---`
			`- JUnit - [https://github.com/KentBeck/junit](https://github.com/KentBeck/junit)`

documentation additions 2012-01-18 05:31:08 +08:00			`Building`
			`---`

Updating README telling people to copy commons-codec 2012-05-08 06:52:34 +08:00			`To create your cordova.jar, copy the commons codec:`
Fix README.md formatting to install commons-codec-1.6.jar 2012-05-10 06:32:53 +08:00
Updating README telling people to copy commons-codec 2012-05-08 06:52:34 +08:00			`mv commons-codec-1.6.jar framework/libs`

			`then run in the framework directory:`
documentation additions 2012-01-18 05:31:08 +08:00
Resolving CB-1496, this is faster than a pull request 2012-09-19 03:57:18 +08:00			`android update project -p . -t android-16`
documentation additions 2012-01-18 05:31:08 +08:00			`ant jar`


README.md: Replace "PhoneGap" with "Cordova" and add incubation disclaimer (This is a test commit to for checking the git push problem by Bryce) 2012-01-06 04:33:26 +08:00			`Cordova Android Developer Tools`
no more ruby dependency 2011-08-19 09:21:51 +08:00			`---`
generating apps works; needs to build js from assets 2010-01-27 09:58:27 +08:00
README.md: Replace "PhoneGap" with "Cordova" and add incubation disclaimer (This is a test commit to for checking the git push problem by Bryce) 2012-01-06 04:33:26 +08:00			`The Cordova developer tooling is split between general tooling and project level tooling.`
updated readme 2011-09-02 05:44:02 +08:00
documented running npm install 2012-05-08 03:31:24 +08:00			`To enable the command-line tools available in the ./bin directory, make`
			`sure you have all of the dependencies installed. You will need`
			[NodeJS](http://nodejs.org) (which should come with `npm`). To install
			`the dependencies:`

			`$ cd bin`
			`$ npm install`

Updated readme. 2011-11-01 10:14:05 +08:00			`General Commands`
updated readme 2010-08-31 07:02:47 +08:00
README.md: Replace "PhoneGap" with "Cordova" and add incubation disclaimer (This is a test commit to for checking the git push problem by Bryce) 2012-01-06 04:33:26 +08:00			`./bin/create [path package activity] ... create the ./example app or a cordova android project`
updated readme 2011-09-02 05:44:02 +08:00			`./bin/bench ............................ generate a bench proj`
			`./bin/autotest ......................... test the cli tools`
slightly better docs 2011-08-19 09:31:13 +08:00			`./bin/test ............................. run mobile-spec`
updated readme 2011-09-02 05:44:02 +08:00
			`Project Commands`

README.md: Replace "PhoneGap" with "Cordova" and add incubation disclaimer (This is a test commit to for checking the git push problem by Bryce) 2012-01-06 04:33:26 +08:00			`These commands live in a generated Cordova Android project.`
updated readme 2011-09-02 05:44:02 +08:00
Brand: cordova 2012-09-11 03:05:57 +08:00			`./cordova/debug [path] ..................... install to first device`
Rename to Cordova 2012-02-02 09:45:49 +08:00			`./cordova/emulate .......................... start avd (emulator) named default`
			`./cordova/log .............................. starts logcat`
slightly better docs 2011-08-19 09:31:13 +08:00
test fully automated from mobile-spec edge 2011-08-19 13:40:09 +08:00			`Running the Example Project`
updated the improved cli docs 2011-08-20 13:20:53 +08:00			`---`

			Start avd (emulator) named `default`:
slightly better docs 2011-08-19 09:31:13 +08:00
no more ruby dependency 2011-08-19 09:21:51 +08:00			`./bin/emulate`
updated readme 2010-08-31 07:02:47 +08:00
Updated readme. 2011-11-01 10:14:05 +08:00			`Create the example project and build it to the first device:`
updated the improved cli docs 2011-08-20 13:20:53 +08:00
			`./bin/create`
updated readme 2011-09-02 05:44:02 +08:00			`cd example`
Rename to Cordova 2012-02-02 09:45:49 +08:00			`./cordova/debug`
updated the improved cli docs 2011-08-20 13:20:53 +08:00
			`Start adb logcat (console.log calls output here):`
slightly better docs 2011-08-19 09:31:13 +08:00
Rename to Cordova 2012-02-02 09:45:49 +08:00			`./cordova/log`
Updating README 2009-12-23 08:01:54 +08:00
README.md: Replace "PhoneGap" with "Cordova" and add incubation disclaimer (This is a test commit to for checking the git push problem by Bryce) 2012-01-06 04:33:26 +08:00			`Creating a new Cordova Android Project`
Updated readme. 2011-11-01 10:14:05 +08:00			`---`
test fully automated from mobile-spec edge 2011-08-19 13:40:09 +08:00
CB-1304: Update PhoneGap References to Apache Cordova 2012-09-04 02:10:00 +08:00			`./bin/create ~/Desktop/myapp com.myapp.special MyApp`
test fully automated from mobile-spec edge 2011-08-19 13:40:09 +08:00
README.md: Replace "PhoneGap" with "Cordova" and add incubation disclaimer (This is a test commit to for checking the git push problem by Bryce) 2012-01-06 04:33:26 +08:00			`Importing a Cordova Android Project into Eclipse`
updated the improved cli docs 2011-08-20 13:20:53 +08:00			`----`
updated readme to reflect change to build process 2010-01-28 07:11:25 +08:00
			`1. File > New > Project...`
			`2. Android > Android Project`
updated readme 2010-08-31 07:02:47 +08:00			`3. Create project from existing source (point to the generated app found in tmp/android)`
Rename to Cordova 2012-02-02 09:45:49 +08:00			`4. Right click on libs/cordova.jar and add to build path`
updated readme to reflect change to build process 2010-01-28 07:11:25 +08:00			`5. Right click on the project root: Run as > Run Configurations`
updated readme 2010-08-31 07:02:47 +08:00			`6. Click on the Target tab and select Manual (this way you can choose the emulator or device to build to)`

Adding tests to the README 2012-05-17 07:13:46 +08:00			`Running Tests`
			`----`
small tweaks to readme re: testing 2012-06-01 07:01:20 +08:00			`Please see details under test/README.md.`
updated readme 2010-08-31 07:02:47 +08:00
updated the improved cli docs 2011-08-20 13:20:53 +08:00			`Further Reading`
updated readme 2010-08-31 07:02:47 +08:00			`---`

updated the improved cli docs 2011-08-20 13:20:53 +08:00			`- [http://developer.android.com](http://developer.android.com)`
CB-1304: Update PhoneGap References to Apache Cordova 2012-09-04 02:10:00 +08:00			`- [http://incubator.apache.org/cordova/](http://incubator.apache.org/cordova/)`
			`- [http://wiki.apache.org/cordova/](http://wiki.apache.org/cordova/)`