Repository: cordova-osx Updated Branches: refs/heads/master 4dc6733c3 -> 48bf5005b
trivial: update docu Project: http://git-wip-us.apache.org/repos/asf/cordova-osx/repo Commit: http://git-wip-us.apache.org/repos/asf/cordova-osx/commit/48bf5005 Tree: http://git-wip-us.apache.org/repos/asf/cordova-osx/tree/48bf5005 Diff: http://git-wip-us.apache.org/repos/asf/cordova-osx/diff/48bf5005 Branch: refs/heads/master Commit: 48bf5005bb0b434189725283daaef5cdc0802e83 Parents: 4dc6733 Author: Tobias Bocanegra <[email protected]> Authored: Tue Feb 2 14:54:40 2016 -0800 Committer: Tobias Bocanegra <[email protected]> Committed: Tue Feb 2 14:59:12 2016 -0800 ---------------------------------------------------------------------- README.md | 47 +++++++++++++++++++---------------------------- 1 file changed, 19 insertions(+), 28 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cordova-osx/blob/48bf5005/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index c85db4f..d0454f0 100644 --- a/README.md +++ b/README.md @@ -23,37 +23,18 @@ Cordova OSX CordovaLib is a framework that enables users to include Cordova in their OS X application projects easily, and also create new Cordova based OS X application projects. +Note that the current focus of this cordova platform is to provide kiosk-like applications for OSX, that usually run fullscreen and have little desktop interaction. So there is no direct support for menus, dock integration, finder integration, documents, etc. Think of it as a mobile app running on a very big screen. + Pre-requisites ------------------------------------------------------------- -Make sure you have installed the latest released OS X SDK which comes with Xcode 6. +Make sure you have installed the latest released OS X SDK which comes with Xcode 6 or later. Download it at [http://developer.apple.com/downloads](http://developer.apple.com/downloads) or the [Mac App Store](http://itunes.apple.com/us/app/xcode/id497799835?mt=12). -Add the Cordova OSX Platform to a CLI project ---------------------------------------------- -Since OSX is not officially released yet, we need to use the development versions of the respective modules where OSX was already added. currently those are: - -* _cordova-lib_ -* _cordova-plugman_ -* _cordova-plugin-file_ - -### Use Development versions for your build - -1. checkout the master branch of _cordova-lib_, _cordova-plugman_, _cordova-cli_ and all the plugins you require -2. link the development version if _cordova-lib_ to _cordova-cli_ and _cordova-plugman_ (see https://github.com/apache/cordova-lib#setup) - - ```` - $ cd cordova-lib/cordova-lib - $ npm install && npm link - $ cd ../../cordova-cli - $ npm link cordova-lib && npm install - $ cd ../cordova-plugman - $ npm link cordova-lib && npm install - ```` - -### Create your project +Create your project +------------------------------------------------------------- -1. (Optionally) Follow the instructions in the [**Command-Line Usage** section](http://cordova.apache.org/docs/en/edge/guide_cli_index.md.html#The%20Command-line%20Interface) of the [Cordova Docs](http://cordova.apache.org/docs/en/edge) to create a new project. For example +1. (Optionally) Follow the instructions in the [**Command-Line Usage**](http://cordova.apache.org/docs/en/latest/guide/cli/index.html) section of the [Cordova Docs](http://cordova.apache.org/docs/en/latest/guide/cli/index.html) to create a new project. For example ```` $ cordova create hello com.example.hello HelloWorld ```` @@ -61,7 +42,7 @@ Since OSX is not officially released yet, we need to use the development version 2. add the osx platform: ```` - $ cordova platform add ../cordova-osx + $ cordova platform add osx $ cordova run osx ```` @@ -120,14 +101,24 @@ Cordova comes with a script that will help you to do this. FAQ --- -None yet. +### How do debug the webview? +You need to enable the `WebDeveloperExtras` for your bundle: + +``` +defaults write com.yourcompany.yourbundleid WebKitDeveloperExtras -bool true +``` +After you changed the defatuls, start the application and right-click inside the webview and select _Inspect Element_. This opens the Safari Developer Tools. + +> **Note**: The _bundleid_ is usually the same as your _widget id_ you define in your `config.xml` unless overridden by the `ios-CFBundleVersion` argument. + BUGS? ----- -File them at the [Cordova Issue Tracker](https://issues.apache.org/jira/browse/CB) +File them at the [Cordova Issue Tracker](https://issues.apache.org/jira/browse/CB) MORE INFO ---------- * [http://cordova.apache.org/](http://cordova.apache.org/) + --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
