README.md 2.69 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 7 8 9
## Requirements
* Xcode 7.0 or later
* OS X 10.10 or later
* Command Line Tools package: https://developer.apple.com/downloads/
* Cocoapods 0.38 or later

## Let's compile!
10
1. Run the compilescript with: ```sh compileVLCforiOS.sh```
11

12 13 14 15 16
    The first time around this will take roughly an hour and take up 7.5GB of free space.

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".
17

Felix Paul Kühne's avatar
Felix Paul Kühne committed
18
If it compiled and ran in your simulator, throw confetti, celebrate or just cheers to that. 
19 20
You got further than a lot of people before you!

21
## Errors you might encounter on the way
22

23
### Ambiguous argument followed by some hash
24

Felix Paul Kühne's avatar
Felix Paul Kühne committed
25 26
If you look at the compilescript you see that VLCKit and Medialibrary are checked out by hash references. 
These are repositories within the VLC-iOS repo and if you encounter this error chances are you just need to go into the subfolders ImportedSources/MediaLibrarykit or ImportedSources/VLCKit and pull the latest commits
27 28 29
then go back and run the script again.
It just didn't know the hash because your repository was not up to date

30
### Connection timed out 
31

Felix Paul Kühne's avatar
Felix Paul Kühne committed
32
VLC has _many_ dependencies. It can happen that when you initially try to build vlc that some libraries are temporarily unavailable.
33 34 35 36 37 38
You have two options:
 
1. either you wait until the library is available again (often the server is just down) and start the script again
or 
2. you try to figure out which file couldn't be downloaded and try to find that resource somewhere else and put in the right place. Looking at the compile scripts helps here :)

39
### Build errors in Xcode
40

Felix Paul Kühne's avatar
Felix Paul Kühne committed
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. 

Felix Paul Kühne's avatar
Felix Paul Kühne committed
45
If you have opened the workspace and still get errors you should check out the Notes section
46

47
## Submitting A Patch
48

Felix Paul Kühne's avatar
Felix Paul Kühne committed
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! 

Felix Paul Kühne's avatar
Felix Paul Kühne committed
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

Felix Paul Kühne's avatar
Felix Paul Kühne committed
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
We're happy to help!