瀏覽代碼

README: Update style

Soomin Lee 6 年之前
父節點
當前提交
5a3d1286e1
共有 1 個文件被更改,包括 39 次插入33 次删除
  1. 39 33
      README.md

+ 39 - 33
README.md

@@ -1,4 +1,8 @@
-<img src="https://www.videolan.org/images/vlckit/logo.svg" alt="VLCKit logo" height="70" >
+<img src="https://www.videolan.org/images/vlckit/logo.svg" alt="VLCKit logo" height="140">
+
+#
+
+**VLCKit** is a generic multimedia library for any audio or video playback needs on macOS, iOS and tvOS.
 
 |              | Platform                                                     | Master                                                       | Cocoapods                                                    |
 | ------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
@@ -6,6 +10,8 @@
 | MobileVLCKit | ![Platform](https://img.shields.io/cocoapods/p/MobileVLCKit.svg?style=flat) | ![CircleCI](https://img.shields.io/circleci/project/github/videolan/vlckit/master.svg) | [![MobileVLCKit is CocoaPods Compatible](https://img.shields.io/cocoapods/v/MobileVLCKit.svg)](https://cocoapods.org/pods/MobileVLCKit) |
 | TVVLCKit     | ![Platform](https://img.shields.io/cocoapods/p/TVVLCKit.svg?style=flat) | ![CircleCI](https://img.shields.io/circleci/project/github/videolan/vlckit/master.svg) | [![TVVLCKit is CocoaPods Compatible](https://img.shields.io/cocoapods/v/TVVLCKit.svg)](https://cocoapods.org/pods/TVVLCKit) |
 
+## Table of content
+
 - [Features](#features)
 - [Use-case](#use-case)
 - [Requirements](#requirements)
@@ -27,24 +33,24 @@
 - [License](#license)
 - [Further reading](#further-reading)
 
-**VLCKit** is a generic multimedia library for any audio or video playback needs on macOS, iOS and tvOS.
-
 ## Features
 
-- Based on **libVLC**, the engine of the popular media player *VLC*
-- Supports playback, active streaming, and media to file conversations on the Mac
+- Wrapper of **libVLC**, the engine of the popular media player *VLC*.
+- Supports playback, active streaming, and media to file conversations on the Mac.
 - Open-source software licensed under [LGPLv2.1](http://opensource.org/licenses/LGPL-2.1/) or later, available in source code and binary form from [VideoLAN's website](http://www.videolan.org/).
-- Easily integratable via [CocoaPods](http://cocoapods.org/)
+- Easily integratable via [CocoaPods](http://cocoapods.org/).
 
 ## Use-case
 
-When will you need VLCKit? Frankly, you will need it whenever you need to play media not supported by QuickTime / AVFoundation or if you require more flexibility.
+When will you need VLCKit?
+
+Frankly, you will need it whenever you need to play media not supported by QuickTime / AVFoundation or if you require more flexibility.
 
-Here are some other common use-cases
+Here are some other common use-cases:
 
-- Playing something else besides H264/AAC files or HLS streams
-- Need subtitles beyond QuickTime’s basic support for Closed Captions
-- Your media source is neither your mobile device nor a basic HTTP server, but a live stream hailing from some weird media server or even a raw DVB signal broadcasted on a local network
+- Playing something else besides H264/AAC files or HLS streams.
+- Need subtitles beyond QuickTime’s basic support for Closed Captions.
+- Your media source is neither your mobile device nor a basic HTTP server, but a live stream hailing from some weird media server or even a raw DVB signal broadcasted on a local network.
 - and more!
 
 ## Requirements
@@ -52,47 +58,47 @@ Here are some other common use-cases
 - iOS 8.4 + / macOS 10.9+ / tvOS 10.2+
 - Xcode 9.0+
 - Cocoapods 1.4+
-- python 3.7 (compile time only)
+- Python 3.7 (compile time only)
 
 ## Installation
 
 ### Cocoapods
 
-[CocoaPods](http://cocoapods.org/) is a dependency manager for Cocoa projects. You can install it with the following command,
+[CocoaPods](http://cocoapods.org/) is a dependency manager for Cocoa projects. You can install it with the following command:
 
 ```bash
-$ gem install cocoapods
+gem install cocoapods
 ```
 
-To integrate VLCKit into your project, specify it in your `Podfile`,
+To integrate the latest VLCKit into your project, specify it in your `Podfile`:
 
 ```ruby
 source 'https://github.com/CocoaPods/Specs.git'
 
 target '<macOS Target>' do
     platform :macos, '10.9'
-    pod 'VLCKit', '3.1.4'
+    pod 'VLCKit', '3.3.0'
 end
 
 target '<iOS Target>' do
     platform :ios, '8.4'
-    pod 'MobileVLCKit', '3.1.4'
+    pod 'MobileVLCKit', '3.3.0'
 end
 
 target '<tvOS Target>' do
-    platform :tvos, '9.0'
-    pod 'TVVLCKit', '3.1.4'
+    platform :tvos, '10.2'
+    pod 'TVVLCKit', '3.3.0'
 end
 ```
 
-Then, run the following command,
+Then, run the following command:
 
 ```bash
-$ pod install
+pod install
 ```
 ### Carthage
 
-[Carthage](https://github.com/Carthage/Carthage) is a way to add frameworks to your Cocoa application. You can install it with the following command,
+[Carthage](https://github.com/Carthage/Carthage) is a way to add frameworks to your Cocoa application. You can install it with the following command:
 
 ```bash
 brew install carthage
@@ -102,20 +108,20 @@ To integrate VLCKit into your project, specify it in your `Cartfile`. The URL de
 
 iOS:
 ```
-binary "https://code.videolan.org/videolan/VLCKit/raw/master/Packaging/MobileVLCKit.json" ~> 3.1.4
+binary "https://code.videolan.org/videolan/VLCKit/raw/master/Packaging/MobileVLCKit.json" ~> 3.3.0
 ```
 
 macOS:
 ```
-binary "https://code.videolan.org/videolan/VLCKit/raw/master/Packaging/VLCKit.json" ~> 3.1.4
+binary "https://code.videolan.org/videolan/VLCKit/raw/master/Packaging/VLCKit.json" ~> 3.3.0
 ```
 
 tvOS:
 ```
-binary "https://code.videolan.org/videolan/VLCKit/raw/master/Packaging/TVVLCKit.json" ~> 3.1.4
+binary "https://code.videolan.org/videolan/VLCKit/raw/master/Packaging/TVVLCKit.json" ~> 3.3.0
 ```
 
-Then, run the following command,
+Then, run the following command:
 
 ```bash
 carthage update
@@ -147,25 +153,25 @@ On iOS and tvOS, you also need to link:
 
 ### Default
 
-Make sure that python 3.7 is installed. Get the package from https://www.python.org - do NOT use homebrew for installation as it will be ignored by VLC's build process.
+Make sure that Python 3.7 is installed. Get the package from https://www.python.org - do NOT use homebrew for installation as it will be ignored by VLC's build process.
 
 Run `compileAndBuildVLCKit.sh` with the `-a ${ARCH}` option to specify the target architecture.
 
-More information can be found under `./compileAndBuildVLCKit.sh -h`
+More information can be found under `./compileAndBuildVLCKit.sh -h`.
 
 ### Build with your own VLC repository
 
-1. Put a vlc repository inside libvlc/vlc
+1. Put a VLC repository inside `libvlc/vlc`.
 
-    `mkdir libvlc && cd libvlc && ln -s ${MYVLCGIT}`
+    `mkdir libvlc && cd libvlc && ln -s "PATH_TO_VLC"`
 
-2. Apply VLC patches needed for VLCKit
+2. Apply VLC patches needed for VLCKit.
 
     `cd vlc`
 
     `git am ../../Resources/MobileVLCKit/patches/*`
 
-3. run `compileAndBuildVLCKit.sh` with the `-n` and the `-a ${ARCH}` option
+3. run `compileAndBuildVLCKit.sh` with the `-n` option.
 
 ## Contribute
 
@@ -201,7 +207,7 @@ For further details, please read the license and consult your lawyer with any qu
 
 ### Forum
 
-If you ever need help, feel free to reach out. The [web forum](http://forum.videolan.org/) is always there for you.
+If you ever need help, feel free to reach out. The [forum](http://forum.videolan.org/) is always there for you.
 
 ### Issues