cordova-android/README.md

<!--
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
#  KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.
#
-->

# Cordova Android

[![NPM](https://nodei.co/npm/cordova-android.png)](https://nodei.co/npm/cordova-android/)

[![Node CI](https://github.com/apache/cordova-android/workflows/Node%20CI/badge.svg?branch=master)](https://github.com/apache/cordova-android/actions?query=branch%3Amaster)
[![codecov.io](https://codecov.io/github/apache/cordova-android/coverage.svg?branch=master)](https://codecov.io/github/apache/cordova-android?branch=master)

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, applications written with web technology: HTML, CSS and JavaScript.

[Apache Cordova](https://cordova.apache.org) is a project of The Apache Software Foundation (ASF).

## Requires

- Java JDK 1.8
- Android SDK [http://developer.android.com](https://developer.android.com/)

## Cordova Android Developer Tools

Use the [Cordova command-line tool](https://www.npmjs.com/package/cordova) to create projects and install plugins.

## Using Android Studio

1. Create a project
2. Import it via "Non-Android Studio Project"

## Running the Native Tests

The `test/` directory in this project contains an Android test project that can be used to run different kinds of native tests. Check out the [README contained therein](test/README.md) for more details!
[CB-3468] Add missing license headers found by RAT 2013-05-29 04:43:38 +08:00			`<!--`
			`#`
			`# Licensed to the Apache Software Foundation (ASF) under one`
			`# or more contributor license agreements. See the NOTICE file`
			`# distributed with this work for additional information`
			`# regarding copyright ownership. The ASF licenses this file`
			`# to you under the Apache License, Version 2.0 (the`
			`# "License"); you may not use this file except in compliance`
			`# with the License. You may obtain a copy of the License at`
CB-5144 Spelling & grammar fixes in README. 2013-10-22 10:55:40 +08:00			`#`
[CB-3468] Add missing license headers found by RAT 2013-05-29 04:43:38 +08:00			`# http://www.apache.org/licenses/LICENSE-2.0`
CB-5144 Spelling & grammar fixes in README. 2013-10-22 10:55:40 +08:00			`#`
[CB-3468] Add missing license headers found by RAT 2013-05-29 04:43:38 +08:00			`# Unless required by applicable law or agreed to in writing,`
			`# software distributed under the License is distributed on an`
			`# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY`
			`# KIND, either express or implied. See the License for the`
			`# specific language governing permissions and limitations`
			`# under the License.`
			`#`
			`-->`
CB-10846 Add Travis and AppVeyor badges to readme 2016-03-11 18:35:14 +08:00
Remove stale info from README.md (close #156) 2015-02-19 10:37:59 +08:00			`# Cordova Android`
no more ruby dependency 2011-08-19 09:21:51 +08:00
chore: various cleanup (#957) * chore: various cleanup * update LICENSE year * update third-party appended licenses * update NOTICE year & format * use correct CI badges on README.md * remove extra markdown from RELEASENOTES.md * chore: update reviewboard url 2020-04-15 11:40:59 +08:00			`[![NPM](https://nodei.co/npm/cordova-android.png)](https://nodei.co/npm/cordova-android/)`

			`[![Node CI](https://github.com/apache/cordova-android/workflows/Node%20CI/badge.svg?branch=master)](https://github.com/apache/cordova-android/actions?query=branch%3Amaster)`
			`[![codecov.io](https://codecov.io/github/apache/cordova-android/coverage.svg?branch=master)](https://codecov.io/github/apache/cordova-android?branch=master)`

			`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, applications written with web technology: HTML, CSS and JavaScript.`
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
Remove stale info from README.md (close #156) 2015-02-19 10:37:59 +08:00			`[Apache Cordova](https://cordova.apache.org) is a project of The Apache Software Foundation (ASF).`
Adding README 2009-11-25 07:11:32 +08:00
Remove stale info from README.md (close #156) 2015-02-19 10:37:59 +08:00			`## Requires`
no more ruby dependency 2011-08-19 09:21:51 +08:00
Updated README to reflect what Android requires more accurately, which is Java 8, not anything less, not anything greater. Java 1.8.x is required. (#929) 2020-04-01 11:55:47 +08:00			`- Java JDK 1.8`
chore: various cleanup (#957) * chore: various cleanup * update LICENSE year * update third-party appended licenses * update NOTICE year & format * use correct CI badges on README.md * remove extra markdown from RELEASENOTES.md * chore: update reviewboard url 2020-04-15 11:40:59 +08:00			`- Android SDK [http://developer.android.com](https://developer.android.com/)`
CB-5144 Spelling & grammar fixes in README. 2013-10-22 10:55:40 +08:00
Remove stale info from README.md (close #156) 2015-02-19 10:37:59 +08:00			`## Cordova Android Developer Tools`
generating apps works; needs to build js from assets 2010-01-27 09:58:27 +08:00
refactor!: remove most platform binaries (#1100) * Remove binaries cordova/lib/* * Remove binary bin/android_sdk_version * Remove binary bin/update script * Remove binary bin/check_reqs * Remove binary bin/create script * Remove binary cordova/build * Remove binary cordova/run * Remove binary cordova/clean * Remove binary cordova/log * Remove unused module cordova/loggingHelper * Update README * Restore target-listing binaries used by CLI Usage: cordova-lib/src/cordova/targets.js * Restore binary bin/android_sdk_version for CLI compatibility This is used in CLI to implement an Android SDK version check for plugins. See https://cordova.apache.org/docs/en/latest/plugin_ref/spec.html#engines-and-engine * Remove version.bat 2021-07-06 21:37:46 +08:00			`Use the [Cordova command-line tool](https://www.npmjs.com/package/cordova) to create projects and install plugins.`
test fully automated from mobile-spec edge 2011-08-19 13:40:09 +08:00
Remove stale info from README.md (close #156) 2015-02-19 10:37:59 +08:00			`## Using Android Studio`
updated readme 2010-08-31 07:02:47 +08:00
Remove stale info from README.md (close #156) 2015-02-19 10:37:59 +08:00			`1. Create a project`
			`2. Import it via "Non-Android Studio Project"`
CB-12859: document how to run the native tests. add a README to the test/ project. 2017-05-26 02:54:25 +08:00
			`## Running the Native Tests`

chore: various cleanup (#957) * chore: various cleanup * update LICENSE year * update third-party appended licenses * update NOTICE year & format * use correct CI badges on README.md * remove extra markdown from RELEASENOTES.md * chore: update reviewboard url 2020-04-15 11:40:59 +08:00			The `test/` directory in this project contains an Android test project that can be used to run different kinds of native tests. Check out the [README contained therein](test/README.md) for more details!