README.md 2.25 KB
Newer Older
1
# How to start development for VLC for iOS:
2

Felix Paul Kühne's avatar
Felix Paul Kühne committed
3 4 5 6
## Requirements
* Xcode 7.0 or later
* OS X 10.10 or later
* Command Line Tools package: https://developer.apple.com/downloads/
Felix Paul Kühne's avatar
Felix Paul Kühne committed
7
* Cocoapods 1.0 or later
Felix Paul Kühne's avatar
Felix Paul Kühne committed
8 9

## Let's compile!
Felix Paul Kühne's avatar
Felix Paul Kühne committed
10
1. Run ```pod update```
11 12 13
2. Open `VLC for iOS.xcworkspace`.
3. Change `BUNDLE_IDENTIFIER_PREFIX` in `SharedConfig.xcconfig` to your domain name in reverse DNS style.
4. Hit "Build and Run".
14

15
## Compile with your own VLCKit build
16
1. Clone a VLCKit repository: `git clone https://code.videolan.org/videolan/VLCKit.git`
17
2. Inside the VLCKit folder, run the following command: `./buildMobileVLCKit.sh -a ${MYARCH}`
18 19 20 21 22 23 24
    
    MYARCH can be `i386` `x86_64` `armv7` `armv7s` or `aarch64`.
    
    Add `-d` for a debug build (to have valid stack straces and asserts).
    
    Add `-n` if you want to use you own VLC repository for VLCKit (See VLCKit README.md).

25 26 27
3. Replace the MobileVLCKit.framework with the one you just build.
    
    Inside your vlc-ios folder, after a `podate update`, do:
28 29 30 31 32 33 34
    
    `cd Pods/MobileVLCKit-unstable/MobileVLCKit-binary`
    
    `rm -rf MobileVLCKit.framework`
    
    `ln -s ${VLCKit}/build/MobileVLCKit.framework`

35 36
4. Hit "Build and Run".

37
## Errors you might encounter on the way
38

39
### Build errors in Xcode
40

41 42
Are you sure you opened the workspace? 
We use cocoapods and it creates a workspace with all the integrated libraries. 
43 44
Chances are you opened the project file. 

45
If you have opened the workspace and still get errors you should check out the Notes section
46

47
## Submitting A Patch
48

49
So you added some code and are ready to contribute your commits but you don't see a way to make a pull request?
50 51
Soo *cough* we work with patches and Mailinglists like any good open source project! 

52
You should take a look at this: https://wiki.videolan.org/Sending_Patches_VLC/ but finally send the patch to ios@videolan.org.
53 54 55

Also, if you haven't yet, you might want to subscribe to this mailinglist: https://mailman.videolan.org/listinfo/ios

56
## Notes
57

58 59
For everything else, check: https://wiki.videolan.org/IOSCompile/
or look here: http://www.videolan.org/support/
60
For fast replies, IRC is probably the best way. We hang out in the #videolan channel on the freenode network. There is also a web interface: http://webchat.freenode.net/
61

62 63
We're happy to help!