Skip to content

Commit e75a050

Browse files
MikanbuMikanbu
committed
Update README
1 parent b3a1ad4 commit e75a050

File tree

1 file changed

+63
-44
lines changed

1 file changed

+63
-44
lines changed

‎README.md

Lines changed: 63 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,46 @@
1-
# VLC iOS
1+
# VLC for iOS & tvOS
22

3-
The best open source player ported to iOS!
3+
This repository has the source code of VLC for iOS and tvOS application.
44

5-
This repository has the source code of the iOS/AppleTV application and mostly the interface.
5+
It's currently written in Objective-C / Swift and uses VLCKit a libvlc wrapper.
66

7-
It's currently written in Obj-C and uses libVLC for the playback.
7+
- [Requirements](#requirements)
8+
- [Building](#building)
9+
- [VLC-iOS](#vlc-ios)
10+
- [Custom VLCKit](#custom-vlckit)
11+
- [Contribute](#contribute)
12+
- [Communication](#communication)
13+
- [Forum](#forum)
14+
- [Issues](#issues)
15+
- [IRC](#irc)
16+
- [License](#license)
17+
- [More](#more)
818

9-
It's completely open source.
19+
## Requirements
20+
* Xcode 9.0+
21+
* macOS 10.12+
22+
* Cocoapods 1.4+
1023

11-
# How to start development for VLC for iOS:
24+
## Building
1225

13-
## Requirements
14-
* Xcode 7.0 or later
15-
* OS X 10.10 or later
16-
* Command Line Tools package: https://developer.apple.com/downloads/
17-
* Cocoapods 1.0 or later
26+
### VLC-iOS
1827

19-
## Let's compile!
20-
1. Run ```pod update```
28+
1. Run `pod update`
2129
2. Open `VLC.xcworkspace`.
22-
3. Change `BUNDLE_IDENTIFIER_PREFIX` in `SharedConfig.xcconfig` to your domain name in reverse DNS style.
23-
4. Hit "Build and Run".
30+
3. Hit "Build and Run".
31+
32+
### Custom VLCkit
33+
34+
Mostly for debugging or advance users, you might want to have a custom local VLCKit build.
35+
36+
1. Clone VLCKit:
37+
38+
`git clone https://code.videolan.org/videolan/VLCKit.git`
39+
2440

25-
## Compile with your own VLCKit build
26-
1. Clone a VLCKit repository: `git clone https://code.videolan.org/videolan/VLCKit.git`
27-
2. Inside the VLCKit folder, run the following command: `./buildMobileVLCKit.sh -a ${MYARCH}`
41+
2. Inside the VLCKit folder, run the following command:
42+
43+
`./buildMobileVLCKit.sh -a ${MYARCH}`
2844

2945
MYARCH can be `i386` `x86_64` `armv7` `armv7s` or `aarch64`.
3046

@@ -42,48 +58,51 @@ It's completely open source.
4258

4359
`ln -s ${VLCKit}/build/MobileVLCKit.framework`
4460

45-
4. Hit "Build and Run".
61+
4. Hit "Build and Run.
62+
63+
## Contribute
64+
65+
### Pull request
66+
67+
If you want to submit a pull request, please make sure to use a descriptive title and description.
68+
69+
### Gitlab issues
70+
71+
You can look through issues we currently have on the [VideoLAN Gitlab](https://code.videolan.org/videolan/vlc-ios/issues).
72+
73+
We even have a [Beginner friendly](https://code.videolan.org/videolan/vlc-ios/issues?label_name%5B%5D=Beginner+friendly) tag if you don't know were to start!
4674

47-
## Errors you might encounter on the way
75+
## Communication
4876

49-
### Build errors in Xcode
77+
### Forum
5078

51-
Are you sure you opened the workspace?
52-
We use cocoapods and it creates a workspace with all the integrated libraries.
53-
Chances are you opened the project file.
79+
If you have any question or you're not sure it's an issue please visit our [forum](https://forum.videolan.org/).
5480

55-
If you have opened the workspace and still get errors you should check out the Notes section
81+
### Issues
5682

57-
## Submitting A Patch
83+
You have encountered an issue and wish to report it to the VLC dev team?
5884

59-
So you added some code and are ready to contribute your commits but you don't see a way to make a pull request?
60-
Soo *cough* we work with patches and Mailinglists like any good open source project!
85+
You can create an issue on our [Gitlab](https://code.videolan.org/videolan/vlc-ios/issues) or on our [bug tracker](https://trac.videolan.org/vlc/).
6186

62-
You should take a look at this: https://wiki.videolan.org/Sending_Patches_VLC/ but finally send the patch to [email protected].
87+
Before creating an issue or ticket, please double check of duplicates!
6388

64-
Also, if you haven't yet, you might want to subscribe to this mailinglist: https://mailman.videolan.org/listinfo/ios
89+
### IRC
6590

66-
## Release
91+
Want to quickly get in touch with us for a question, or even just to talk?
6792

68-
The process of releasing new builds of VLC to iTunes Connect is automated with fastlane.
93+
You will alawys find someone of the VLC team on IRC, __#videolan__ channel on the freenode network.
94+
If you don't have an IRC client, you can always use the [freenode webchat](https://webchat.freenode.net/).
6995

70-
To release a new version of VLC for iOS, run the following command:
71-
```
72-
bundle exec fastlane release platform:iOS
73-
```
96+
## License
7497

75-
To release a new version of VLC for tvOS, run the following command:
76-
```
77-
bundle exec fastlane release platform:tvOS
78-
```
98+
VLC-iOS is under the GPLv2 (or later) and the MPLv2 license.
7999

80-
Please find further information about this process in [fastlane/README.md](./fastlane/README.md)
100+
See [COPYING](./COPYING) for more license info.
81101

82-
## Notes
102+
## More
83103

84-
For everything else, check: https://wiki.videolan.org/IOSCompile/
104+
For everything else, check: https://wiki.videolan.org/
85105
or look here: http://www.videolan.org/support/
86-
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/
87106

88107
We're happy to help!
89108

0 commit comments

Comments
 (0)