README.md 3.81 KB
Newer Older
Soomin Lee's avatar
Soomin Lee committed
1 2 3 4 5 6
<h3 align="center">
  <a href="https://www.videolan.org/images/vlc-ios/readme_banner.png">
  <img src="https://www.videolan.org/images/vlc-ios/readme_banner.png?raw=true" alt="VLC-iOS banner">
  </a>
</h3>

7 8 9
This is the official mirror repository of VLC for iOS and tvOS application.

_You can find the official repository [here](https://code.videolan.org/videolan/vlc-ios/)._
10

Soomin Lee's avatar
Soomin Lee committed
11
It's currently written in Objective-C / Swift and uses [VLCKit](https://code.videolan.org/videolan/VLCKit), a libvlc wrapper.
12

Soomin Lee's avatar
Soomin Lee committed
13 14 15 16 17 18 19 20 21
- [Requirements](#requirements)
- [Building](#building)
    - [VLC-iOS](#vlc-ios)
    - [Custom VLCKit](#custom-vlckit)
- [Contribute](#contribute)
- [Communication](#communication)
    - [Forum](#forum)
    - [Issues](#issues)
    - [IRC](#irc)
22
- [Code of Conduct](#code-of-conduct)
Soomin Lee's avatar
Soomin Lee committed
23 24
- [License](#license)
- [More](#more)
25

Soomin Lee's avatar
Soomin Lee committed
26 27 28 29
## Requirements
* Xcode 9.0+
* macOS 10.12+
* Cocoapods 1.4+
30

Soomin Lee's avatar
Soomin Lee committed
31
## Building
32

Soomin Lee's avatar
Soomin Lee committed
33
### VLC-iOS
Felix Paul Kühne's avatar
Felix Paul Kühne committed
34

35
1. Run `pod install`.
36
2. Open `VLC.xcworkspace`.
Soomin Lee's avatar
Soomin Lee committed
37 38 39 40
3. Hit "Build and Run".

### Custom VLCkit

Soomin Lee's avatar
Soomin Lee committed
41
Mostly for debugging or advanced users, you might want to have a custom local VLCKit build.
Soomin Lee's avatar
Soomin Lee committed
42 43 44 45 46

1. Clone VLCKit:

    `git clone https://code.videolan.org/videolan/VLCKit.git`

47

Soomin Lee's avatar
Soomin Lee committed
48 49
2. Inside the VLCKit folder, run the following command:

50
    `./compileAndBuildVLCKit.sh -a ${MYARCH}`
51

52
    MYARCH can be `i386` `x86_64` `armv7` `armv7s` or `aarch64`.
53

54
    Add `-d` for a debug build (to have valid stack straces and asserts).
55

Jeremiah Njoroge's avatar
Jeremiah Njoroge committed
56
    Add `-n` if you want to use you own VLC repository for VLCKit (See [VLCKit README.md](https://code.videolan.org/videolan/VLCKit/blob/master/README.md)).
57

58
3. Replace the MobileVLCKit.framework with the one you just build.
59

Jeremiah Njoroge's avatar
Jeremiah Njoroge committed
60
    Inside your vlc-ios folder, after a `pod update`, do:
61

62
    `cd Pods/MobileVLCKit-unstable/MobileVLCKit-binary`
63

64
    `rm -rf MobileVLCKit.framework`
65

66 67
    `ln -s ${VLCKit}/build/MobileVLCKit.framework`

Jeremiah Njoroge's avatar
Jeremiah Njoroge committed
68
4. Hit "Build and Run".
Soomin Lee's avatar
Soomin Lee committed
69 70 71 72 73

## Contribute

### Pull request

74
Pull request are more than welcome! If you do submit one, please make sure to use a descriptive title and description.
Soomin Lee's avatar
Soomin Lee committed
75

Soomin Lee's avatar
Soomin Lee committed
76 77 78 79 80 81 82 83 84 85 86 87
### Commit

We try to follow a simple set of rules, outlined by this [guide](https://chris.beams.io/posts/git-commit/).

Additionally, commit messages should have all the information needed to understand the commit easily as the follwing:

`Subject: Brief description(ticket related action)`

For example:

`UPnP: Remove iOS 7 compatiblity code(closes #166)`

Soomin Lee's avatar
Soomin Lee committed
88 89 90 91
### Gitlab issues

You can look through issues we currently have on the [VideoLAN Gitlab](https://code.videolan.org/videolan/vlc-ios/issues).

Soomin Lee's avatar
Soomin Lee committed
92
A [beginner friendly](https://code.videolan.org/videolan/vlc-ios/issues?label_name%5B%5D=Beginner+friendly) tag is available if you don't know where to start.
93

Soomin Lee's avatar
Soomin Lee committed
94
## Communication
95

Soomin Lee's avatar
Soomin Lee committed
96
### Forum
97

98
If you have any question or if you're not sure it's actually an issue, please visit our [forum](https://forum.videolan.org/).
99

Soomin Lee's avatar
Soomin Lee committed
100
### Issues
101

Soomin Lee's avatar
Soomin Lee committed
102
You have encountered an issue and wish to report it to the VLC dev team?
103

104
You can create one on our [Gitlab](https://code.videolan.org/videolan/vlc-ios/issues) or on our [bug tracker](https://trac.videolan.org/vlc/).
105

106
Before creating an issue or ticket, please double check for duplicates!
107

Soomin Lee's avatar
Soomin Lee committed
108
### IRC
109

Soomin Lee's avatar
Soomin Lee committed
110
Want to quickly get in touch with us for a question, or even just to talk?
111

112
You will always find someone from the VLC team on IRC, __#videolan__ channel on the freenode network.
113

114
For VLC-iOS specific questions, you can find us on __#vlc-ios__.
115

Soomin Lee's avatar
Soomin Lee committed
116
If you don't have an IRC client, you can always use the [freenode webchat](https://webchat.freenode.net/).
117

118 119 120 121
## Code of Conduct

Please read and follow the [VideoLAN CoC](https://wiki.videolan.org/Code_of_Conduct/).

Soomin Lee's avatar
Soomin Lee committed
122
## License
123

Soomin Lee's avatar
Soomin Lee committed
124
VLC-iOS is under the GPLv2 (or later) and the MPLv2 license.
125

Soomin Lee's avatar
Soomin Lee committed
126
See [COPYING](./COPYING) for more license info.
127

Soomin Lee's avatar
Soomin Lee committed
128
## More
129

Soomin Lee's avatar
Soomin Lee committed
130
For everything else, check our [wiki](https://wiki.videolan.org/) or our [support page](http://www.videolan.org/support/).
131

132
We're happy to help!