Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: reformat #26

Closed
wants to merge 2 commits into from
Closed

README: reformat #26

wants to merge 2 commits into from

Conversation

@mkchoi212
Copy link
Contributor

@mkchoi212 mkchoi212 commented Jul 16, 2018

  • Added overview table, logo
  • Made grammatical/format changes
@mkchoi212 mkchoi212 force-pushed the mkchoi212:beginner branch 3 times, most recently from 999ccbd to 7c33b62 Jul 16, 2018
@mkchoi212 mkchoi212 changed the title README: add beginners guide and overview table WIP: reformat README Jul 16, 2018
@mkchoi212 mkchoi212 force-pushed the mkchoi212:beginner branch from 7c33b62 to 04562a4 Jul 16, 2018
@mkchoi212 mkchoi212 changed the title WIP: reformat README README: reformat Jul 16, 2018
@mkchoi212 mkchoi212 force-pushed the mkchoi212:beginner branch 3 times, most recently from 3de360e to 9bc61cc Jul 17, 2018
README.md Outdated
@@ -1,37 +1,90 @@
# VLCKit
<img src="./logo.svg" alt="VLCKit logo" height="70" >

This comment has been minimized.

@mkchoi212

mkchoi212 Jul 17, 2018
Author Contributor

Needs to be uploaded to videolan.org/images

This comment has been minimized.

@carolanitz

carolanitz Jul 17, 2018
Member

do you have a preview for this ?

This comment has been minimized.

@carolanitz

carolanitz Jul 17, 2018
Member

never mind just saw it in your repo :D

This comment has been minimized.

@mkchoi212

mkchoi212 Jul 17, 2018
Author Contributor

Here ya go :D https://github.com/mkchoi212/vlckit/blob/7172ae66c2d333d9adb4b7745fc4f73455954c91/README.md

btw for future references, you can go to Files changed -> View to see file previews

README.md Outdated
- Xcode 9.0+
- Cocoapods 1.4+

## Installation

This comment has been minimized.

@mkchoi212

mkchoi212 Jul 17, 2018
Author Contributor

Are there any other additional installation methods that should be covered? Like Carthage?

This comment has been minimized.

@carolanitz

carolanitz Jul 17, 2018
Member

Carthage is not supported

README.md Outdated
- 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

This comment has been minimized.

@mkchoi212

mkchoi212 Jul 17, 2018
Author Contributor

Not 100% on the Xcode / Cocoapods requirements

This comment has been minimized.

@carolanitz

carolanitz Jul 17, 2018
Member

Xcode and Cocoapods is fine

@mkchoi212 mkchoi212 force-pushed the mkchoi212:beginner branch from 9bc61cc to 7172ae6 Jul 17, 2018
Copy link
Member

@carolanitz carolanitz left a comment

looks really really good!! I also really like to show the latest Version available :)

README.md Outdated

## Requirements

- iOS 8.0 + / macOS 10.9+ / tvOS 9.0+

This comment has been minimized.

@carolanitz

carolanitz Jul 17, 2018
Member

tvOS 10.2 from what we have in the News unless felix commits weren't cherry-picked

README.md Outdated
- 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

This comment has been minimized.

@carolanitz

carolanitz Jul 17, 2018
Member

Xcode and Cocoapods is fine

README.md Outdated
- Xcode 9.0+
- Cocoapods 1.4+

## Installation

This comment has been minimized.

@carolanitz

carolanitz Jul 17, 2018
Member

Carthage is not supported

README.md Outdated

### GitLab Issues

You can look through the currently open issues on [GitLab] and choose the one that interests you the most.

This comment has been minimized.

@carolanitz

carolanitz Jul 17, 2018
Member

you can link here to the issues :)

README.md Outdated
> Q. VLCKit being an open-source software, what does this mean for me and the end-user? And wasn’t MobileVLC removed from the App Store in 2011 for some crazy licensing reason?
VLCKit being open-source means that you get access to the whole stack. There is no blackbox. All the source code is there at your fingertips. No reverse-engineering is needed and there are no private APIs.

This comment has been minimized.

@carolanitz

carolanitz Jul 17, 2018
Member

Since we don't explain why we got removed from the App Store can we remove this bit up here ? Also how open source works doesn't need to be in a README :) @fkuehne ? okay with that ?

README.md Outdated

### Forum

If you ever need help, feel free to reach out. The [web forum] is always there for you.

This comment has been minimized.

README.md Outdated

### Issues

Did you find a bug and want to report it to us? You can create an issue on [GitLab] or on our [bug tracker].

This comment has been minimized.

@carolanitz

carolanitz Jul 17, 2018
Member

liiiiinks :D

README.md Outdated
[bug tracker]: <https://trac.videolan.org/vlc/>
[freenode]: <http://www.freenode.net/>
[freenode webchat]: <http://webchat.freenode.net/>
[VideoLAN wiki]: <https://wiki.videolan.org/VLCKit/>

This comment has been minimized.

@carolanitz

carolanitz Jul 17, 2018
Member

I would move most of them inline

@mkchoi212 mkchoi212 force-pushed the mkchoi212:beginner branch from 7172ae6 to 7805b50 Jul 18, 2018
@mkchoi212 mkchoi212 force-pushed the mkchoi212:beginner branch from 7805b50 to 7f945b4 Jul 18, 2018
@mkchoi212 mkchoi212 force-pushed the mkchoi212:beginner branch from 7f945b4 to f303579 Jul 18, 2018
@mkchoi212
Copy link
Contributor Author

@mkchoi212 mkchoi212 commented Jul 18, 2018

merged

@mkchoi212 mkchoi212 closed this Jul 18, 2018
@mkchoi212 mkchoi212 deleted the mkchoi212:beginner branch Jul 18, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
You can’t perform that action at this time.