deprecation notice
[cordova-firefoxos.git] / README.md
index 567828fbe631817696185753e5cc55d5ac0c4165..2f8f68545d46074d4280f15430821b437e9d48fc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,45 +1,48 @@
-Cordova FirefoxOS (Boot 2 Gecko)
+<!--
+#
+# 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 Firefox OS (Boot 2 Gecko)
 ==============================
 
-Introduction
-------------
-
-Firefox OS is an open source operating system for smartphones and tablet computers being developed by Mozilla. It is designed to allow HTML5 applications to integrate directly with the device's hardware using JavaScript.
-
-cordova-firefoxos allows developers to use the cross platform APIs in Cordova to target the Firefox OS. Most APIs are just proxied to the matching Firefox OS API calls.
+---
+📌 **Deprecation Notice**
 
+This repository is deprecated and no more work will be done on this by Apache Cordova. You can continue to use this and it should work as-is but any future issues will not be fixed by the Cordova community.
 
-Prerequisties:
-==============
+Feel free to fork this repository and improve your fork. Existing forks are listed in [Network](../../network) and [Forks](../../network/members).
 
-A lot of good documentation is available on the [Mozilla Developer Network](https://developer.mozilla.org/en/docs/Mozilla/Firefox_OS)
+- Learn more: https://github.com/apache/cordova/blob/master/deprecated.md#deprecated-platforms
+---
 
-A simulator (runs as a Firefox plugin) is availble [here](http://people.mozilla.org/~myk/r2d2b2g/)
-
-The following software is required to package and deploy an app directly to a Firefox OS device:
--[Android SDK](http://developer.android.com/sdk/index.html)
--on Mac you will need to install XCode & Command Line Tools for XCode
--Firefox OS device with OS Version 1.0.0.0 prerelease
+Introduction
+------------
 
-Getting Started:
-================
+[Firefox OS](http://www.mozilla.org/en-US/firefox/os/) is an open source operating system for smartphones and tablet computers being developed by Mozilla. It is designed to allow HTML5 applications to integrate directly with the device's hardware using JavaScript.
 
-1. Bootstrap your computer so to make sure that you have all the prerequisites for building Firefox
-- instructions can be found under the "Build prerequisites" section on the following [page](https://developer.mozilla.org/en-US/docs/Simple_Firefox_build)
-2. Clone the Firefox repository: git clone git://github.com/mozilla/mozilla-central.git
-3. Build Firefox by following the instructions under the "Building" on the following [page](https://developer.mozilla.org/en-US/docs/Simple_Firefox_build)
-4. Clone the cordova-firefoxos repository
+cordova-firefoxos allows developers to use the cross platform APIs in Cordova to target the Firefox OS. Most APIs are just proxied to the matching Firefox OS API calls.
 
-If Deploying to device:
+Prerequisties
+==============
 
-5. Modify the XPCSHELL constant in the Makefile to point to the location of xpcshell on your computer
-6. Modify the ADB constant in the Makefile to point to the location of adb on your computer
-7. Make sure the Firefox OS device has remote debugging enabled. To enable remote debugging navigate to the following settings on the device: Settings->Device Information->More Information->Developer->Remote Debugging.
-8. Run the Makefile by typing "make" into the command line.
-9. The device should prompt you to allow a remote connection, your Apache Cordova Firefox OS app will be installed to the device once you accept the prompt. 
+There are no prerequisites for adding Firefox OS as a Cordova platform. For usage, setting up debugging environment and running on the device, see the [Cordova support for Firefox OS](https://developer.mozilla.org/en-US/Apps/Tools_and_frameworks/Cordova_support_for_Firefox_OS) page on Mozilla Developer Network.
 
-If Deploying to simulator:
+For platform development information, check out the [Firefox OS cordova development page](http://mozilla-cordova.github.io)
 
-7. Open the Firefox OS simulator add-on by going to Tools->Web Developer->Firefox OS Simulator
-8. Start the simulator
-9. Click on the Add Directory button and then choose the manifest.webapp file in the framework folder of your Apache Cordova app.
\ No newline at end of file
+A lot of good documentation on Firefox OS development is also available on the [Mozilla Developer Network](https://developer.mozilla.org/en/docs/Mozilla/Firefox_OS).