deprecation notice
[cordova-firefoxos.git] / README.md
index 0b9c649b365932bd48610a0c0510788a55649a9d..2f8f68545d46074d4280f15430821b437e9d48fc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,72 +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)
 ==============================
 
 ==============================
 
-Directory Structure
--------------------
+---
+📌 **Deprecation Notice**
 
 
-    framework/ ... Any framework (non app specific code)
-    javascript/ .. Cordova JavaScript (built from the cordova-js project)
-    bin/ ......... Scripts for project creation
+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.
 
 
-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-b2g 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.
-
-
-Getting Started
-===============
-
-A lot of good documentation is available on the [Mozilla Developer Network](https://developer.mozilla.org/en/docs/Mozilla/Firefox_OS)
-
-A simulator (runs as a Firefox plugin) is availble [here](http://people.mozilla.org/~myk/r2d2b2g/)
-
-Installing the cordova-b2g framework
-====================================
-
-Cloning the cordova-b2g repository always provides you with the latest (EDGE) version of the Cordova code.  To clone the repository, do the following:
+Feel free to fork this repository and improve your fork. Existing forks are listed in [Network](../../network) and [Forks](../../network/members).
 
 
-    $ cd ~/some/path
-    $ git clone https://github.com/gtanner/cordova-b2g.git
+- Learn more: https://github.com/apache/cordova/blob/master/deprecated.md#deprecated-platforms
+---
 
 
-Cordova B2G Developer Tools
----------------------------
-
-The Cordova developer tooling is split between general tooling and project level tooling.  Currently the tooling will only work on OSX or Linux.
-
-### General Commands
-
-    ./bin/create [path appname] ...... creates a sample app with the specified path
-
-#### Running the Example Project
-
-Create the example project and build it to the first device:
-
-    ./bin/create
-    cd example
-    ./cordova/debug
-
-This will start up a web server on port 8008 and ask you to navigate your
-phone or simulator to http://localhost:8008/install.html.  This is really only
-needed to install like you would from an app store.
-
-You may also use the simluator and Add the www directory to it (point at the manifest.webapp) in that folder. This will
-allow you to refresh the app easier when developing.
+Introduction
+------------
 
 
-#### Creating a new Cordova B2G
+[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.
 
 
-    ./bin/create ~/Desktop/myapp MyApp
+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.
 
 
-### Project Commands
+Prerequisties
+==============
 
 
-These commands live in a generated Cordova B2G project. 
+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.
 
 
-    ./cordova/run ............................ install to a connected device or simulator
-    ./cordova/build .......................... build project, but do not deploy to simulator or device
+For platform development information, check out the [Firefox OS cordova development page](http://mozilla-cordova.github.io)
 
 
-There is currently no way to automate installing to the simulator or device so
-we are currently just hosting an install.html file on the webserver hosting the app
-that you can point your device/simulator to and install the app.  Once more commandline
-tools become available this will probably change.
+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).