jimmy54 / winobjc Goto Github PK

#Welcome to the Windows Bridge for iOS project preview

##What is WinObjC? Windows Bridge for iOS (also referred to as WinObjC) is a Microsoft open source project that provides an Objective-C development environment for Visual Studio/Windows. In addition, WinObjC provides support for iOS API compatibility.

The following sections will help you get started and you can view our wiki for more detailed information.

##Where to get it

Download the Windows Bridge for iOS SDK here

##Getting started with WinObjC To use WinObjC, there are a few requirements. You need:

• Windows 10

• Visual Studio 2015 with Windows developer tools. Visual Studio 2015 Community is available for free here. Select (at least) the following components during installation:

  1. Programming Languages -> Visual C++

  2. Universal Windows App Development Tools (all)

  3. Windows 8.1 and Windows Phone 8.0/8.1 Tools (all)

The best way to get started with WinObjC is to run one of the samples. We recommend starting with the WOCCatalog sample app, which demonstrates an assortment of iOS and XAML UI controls. To run the sample:

1. Extract the SDK zip file to a local directory

2. Navigate to winobjc/samples/WOCCatalog in the extracted directory

3. Double-click on WOCCatalog-WinStore10.sln to open in VS2015

4. In VS2015 right-click on the WOCCatalog (Universal Windows) project

5. Select Set as StartUp project

6. Use Ctrl-F5 to build and run the app

For guidance about importing your own Xcode project and other Windows Bridge for iOS SDK details, see the wiki

##Contributions

There are many ways that you can contribute to the WinObjC project:

• Submit a bug
• Verify fixes for bugs
• Submit a code fix for a bug
• Submit a feature request
• Submit a unit test
• Tell others about the WinObjC project
• Tell the developers how much you appreciate the project

###Pull requests

You will need to sign a Contribution License Agreement (CLA) before submitting your pull request. To complete the CLA, you will need to submit the request via the form and then electronically sign the CLA when you receive an email containing a link to the document.

This process needs to only be done once for any Microsoft open source project.

###Contributing to README and Wiki

You do not need to sign a Contribution License Agreement if you are just contributing to the README or the Wiki. However, by submitting a contribution to the README or the Wiki, you are contributing it under the Creative Commons CC0 1.0 Universal Public Domain Dedication.

As this project is still under active development, there are a few features that are not yet built out:

1. x86 only today ARM support coming soon
2. Compiler optimizations will not work and will likely crash clang, debug builds only
3. Autolayout
4. Storyboard support
5. MapKit
6. AssetsLibrary
7. AddressBook
8. Ads
9. Objective-C annotations
10. Media Capture and Playback

##Problems? If you have any questions, we're listening and will do our best to help. Just go to http://stackoverflow.com/ and tag your questions with WinObjC. You can also get more information at our wiki

##Directory structure

• bin/ : Various prebuilt tools
• build/ : Projects/solutions to build the SDK
• deps/ : Open source dependencies
  • prebuilt/ : Prebuilt binaries for various architectures
• Frameworks/ : Implementation of iOS-style Frameworks
• include/ : SDK headers (including headers for iOS-style Frameworks)
  • Platform/ : Headers for Windows Objective-C bindings for various OS versions
• msvc/ : Visual Studio integration files
• samples/ : Assorted samples
• tools/ : Source code to tools