Google Git
Sign in
apache / cordova-osx / 00d9c6349f7d2957292f5f43455aa8f7e8746e3d
commit00d9c6349f7d2957292f5f43455aa8f7e8746e3d[log] [tgz]
authorTobias Bocanegra <tripod@adobe.com>Mon Nov 16 22:06:30 2015 -0800
committerTobias Bocanegra <tripod@adobe.com>Mon Nov 16 22:06:30 2015 -0800
tree72545928070f26ee7f1a67fe95b99c131ed9a397
parent2d3d604ff54ce238658aa1d620833e5965fcac6a [diff]
simple: CDV.h is not exported
2 files changed
tree: 72545928070f26ee7f1a67fe95b99c131ed9a397
  1. bin/
  2. cordova-js-src/
  3. CordovaLib/
  4. hooks/
  5. tests/
  6. .gitignore
  7. .jshintignore
  8. .jshintrc
  9. .ratignore
  10. .travis.yml
  11. component.json
  12. CONTRIBUTING.md
  13. LICENSE
  14. NOTICE
  15. package.json
  16. README.md
  17. RELEASENOTES.md
README.md

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.

Pre-requisites

Make sure you have installed the latest released OS X SDK which comes with Xcode 6. Download it at http://developer.apple.com/downloads or the Mac App Store.

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

  1. (Optionally) Follow the instructions in the Command-Line Usage section of the Cordova Docs to create a new project. For example

    $ cordova create hello com.example.hello HelloWorld

  2. add the osx platform:

    $ cordova platform add ../cordova-osx
$ cordova run osx

  3. You can also open the project in XCode:

    $ open platforms/osx/<yourproject>.xcodeproj

Add plugins

  1. if you need the file-plugin add the master branch version, eg:

    $ cordova plugin add https://github.com/apache/cordova-plugin-file.git

Create a Cordova OSX Standalone project

  1. Download the source

  2. execute the create command to setup an empty project:

    $ bin/create <path_to_new_project> <package_name> <project_name>

    for example

    $ bin/create ../Foo org.apache.foo FooBar

Add plugins

  1. if you need the file-plugin add the master branch version, eg:

    $ cordova plugin add https://github.com/apache/cordova-plugin-file.git

Updating a CordovaLib subproject reference in your project

When you update to a new Cordova version, you may need to update the CordovaLib reference in an existing project. Cordova comes with a script that will help you to do this.

  1. Launch Terminal.app
  2. Go to the location where you installed Cordova, in the bin sub-folder
  3. Run update /path/to/your/project

FAQ

None yet.

BUGS?

File them at the Cordova Issue Tracker

MORE INFO