README.md 4.2 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
- [Requirements](#requirements)
- [Building](#building)
    - [VLC-iOS](#vlc-ios)
    - [Custom VLCKit](#custom-vlckit)
17
    - [Beginner's Guide](#beginners-guide)
Soomin Lee's avatar
Soomin Lee committed
18 19 20 21 22
- [Contribute](#contribute)
- [Communication](#communication)
    - [Forum](#forum)
    - [Issues](#issues)
    - [IRC](#irc)
23
- [Code of Conduct](#code-of-conduct)
Soomin Lee's avatar
Soomin Lee committed
24 25
- [License](#license)
- [More](#more)
26

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

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

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

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

### Custom VLCkit

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

1. Clone VLCKit:

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

48

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

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

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

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

Jeremiah Njoroge's avatar
Jeremiah Njoroge committed
57
    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)).
58

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

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

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

65
    `rm -rf MobileVLCKit.framework`
66

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

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

71 72 73 74 75 76
### Beginner's Guide

Can't get your project to build or run? Head over to the [beginner's guide](https://code.videolan.org/videolan/vlc-ios/wikis/Beginner-Guide) for help on common issues beginners tend to run into.

If you can't find your problem on the guide, please feel free to [submit an issue](https://code.videolan.org/videolan/vlc-ios/issues).

Soomin Lee's avatar
Soomin Lee committed
77 78 79 80
## Contribute

### Pull request

81
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
82

Soomin Lee's avatar
Soomin Lee committed
83 84 85 86 87 88 89 90 91 92 93 94
### 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
95 96 97 98
### 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
99
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.
100

Soomin Lee's avatar
Soomin Lee committed
101
## Communication
102

Soomin Lee's avatar
Soomin Lee committed
103
### Forum
104

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

Soomin Lee's avatar
Soomin Lee committed
107
### Issues
108

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

111
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/).
112

113
Before creating an issue or ticket, please double check for duplicates!
114

Soomin Lee's avatar
Soomin Lee committed
115
### IRC
116

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

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

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

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

125 126 127 128
## Code of Conduct

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

Soomin Lee's avatar
Soomin Lee committed
129
## License
130

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

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

Soomin Lee's avatar
Soomin Lee committed
135
## More
136

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

139
We're happy to help!