Commit 70beaad7 authored by Felix Paul Kühne's avatar Felix Paul Kühne

readme: Minor improvements

parent b5bb2d36
#How to start development for VLC for iOS: # How to start development for VLC for iOS:
1. Run the compilescript with: sh compileVLCforiOS.sh 1. Run the compilescript with: sh compileVLCforiOS.sh
...@@ -7,16 +7,16 @@ The first time around this will take roughly an hour and take up 7.5GB of free s ...@@ -7,16 +7,16 @@ The first time around this will take roughly an hour and take up 7.5GB of free s
If it compiled and ran in your simulator, throw confetti, celebrate or just cheers to that. If it compiled and ran in your simulator, throw confetti, celebrate or just cheers to that.
You got further than a lot of people before you! You got further than a lot of people before you!
##Errors you might encounter on the way ## Errors you might encounter on the way
###Ambiguous argument followed by some hash ### Ambiguous argument followed by some hash
If you look at the compilescript you see that VLCKit and Medialibrary are checked out by hash references. 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 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
then go back and run the script again. then go back and run the script again.
It just didn't know the hash because your repository was not up to date It just didn't know the hash because your repository was not up to date
###Connection timed out ### Connection timed out
VLC has _many_ dependencies. It can happen that when you initially try to build vlc that some libraries are temporarily unavailable. VLC has _many_ dependencies. It can happen that when you initially try to build vlc that some libraries are temporarily unavailable.
You have two options: You have two options:
...@@ -25,7 +25,7 @@ You have two options: ...@@ -25,7 +25,7 @@ You have two options:
or 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 :) 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 :)
###Build errors in Xcode ### Build errors in Xcode
Are you sure you opened the workspace? Are you sure you opened the workspace?
We use cocoapods and it creates a workspace with all the integrated libraries. We use cocoapods and it creates a workspace with all the integrated libraries.
...@@ -33,7 +33,7 @@ Chances are you opened the project file. ...@@ -33,7 +33,7 @@ Chances are you opened the project file.
If you have opened the workspace and still get errors you should check out the Notes section If you have opened the workspace and still get errors you should check out the Notes section
##Submitting A Patch ## Submitting A Patch
So you added some code and are ready to contribute your commits but you don't see a way to make a pull request? So you added some code and are ready to contribute your commits but you don't see a way to make a pull request?
Soo *cough* we work with patches and Mailinglists like any good open source project! Soo *cough* we work with patches and Mailinglists like any good open source project!
...@@ -42,10 +42,10 @@ You should take a look at this: https://wiki.videolan.org/Sending_Patches_VLC/ b ...@@ -42,10 +42,10 @@ You should take a look at this: https://wiki.videolan.org/Sending_Patches_VLC/ b
Also, if you haven't yet, you might want to subscribe to this mailinglist: https://mailman.videolan.org/listinfo/ios Also, if you haven't yet, you might want to subscribe to this mailinglist: https://mailman.videolan.org/listinfo/ios
##Notes ## Notes
For everything else, check: https://wiki.videolan.org/IOSCompile/ For everything else, check: https://wiki.videolan.org/IOSCompile/
or look here: http://www.videolan.org/support/ or look here: http://www.videolan.org/support/
For fast replies, IRC is probably the best way. 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/
We're happy to help! We're happy to help!
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment