Skip to content

README: reformat#26

Closed
mkchoi212 wants to merge 2 commits intovideolan:masterfrom
mkchoi212:beginner
Closed

README: reformat#26
mkchoi212 wants to merge 2 commits intovideolan:masterfrom
mkchoi212:beginner

Conversation

@mkchoi212
Copy link
Contributor

@mkchoi212 mkchoi212 commented Jul 16, 2018 •
edited
Loading

  • Added overview table, logo
  • Made grammatical/format changes

@mkchoi212 mkchoi212 force-pushed the beginner branch 3 times, most recently from 999ccbd to 7c33b62 Compare July 16, 2018 05:25
@mkchoi212 mkchoi212 changed the title README: add beginners guide and overview table WIP: reformat README Jul 16, 2018
@mkchoi212 mkchoi212 changed the title WIP: reformat README README: reformat Jul 16, 2018
@mkchoi212 mkchoi212 force-pushed the beginner branch 3 times, most recently from 3de360e to 9bc61cc Compare July 17, 2018 06:07
mkchoi212
mkchoi212 commented Jul 17, 2018
View reviewed changes
README.md Outdated
@@ -1,37 +1,90 @@
# VLCKit
<img src="./logo.svg" alt="VLCKit logo" height="70" >
Copy link
Contributor Author

@mkchoi212 mkchoi212 Jul 17, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs to be uploaded to videolan.org/images

Copy link
Member

@carolanitz carolanitz Jul 17, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do you have a preview for this ?

Copy link
Member

@carolanitz carolanitz Jul 17, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

never mind just saw it in your repo :D

Copy link
Contributor Author

@mkchoi212 mkchoi212 Jul 17, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

mkchoi212
mkchoi212 commented Jul 17, 2018
View reviewed changes
README.md
- Xcode 9.0+
- Cocoapods 1.4+

## Installation
Copy link
Contributor Author

@mkchoi212 mkchoi212 Jul 17, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member

@carolanitz carolanitz Jul 17, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Carthage is not supported

mkchoi212
mkchoi212 commented Jul 17, 2018
View reviewed changes
README.md
- 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
Copy link
Contributor Author

@mkchoi212 mkchoi212 Jul 17, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not 100% on the Xcode / Cocoapods requirements

Copy link
Member

@carolanitz carolanitz Jul 17, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Xcode and Cocoapods is fine

carolanitz
carolanitz requested changes Jul 17, 2018
View reviewed changes
Copy link
Member

@carolanitz carolanitz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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+
Copy link
Member

@carolanitz carolanitz Jul 17, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

README.md
- 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
Copy link
Member

@carolanitz carolanitz Jul 17, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Xcode and Cocoapods is fine

README.md
- Xcode 9.0+
- Cocoapods 1.4+

## Installation
Copy link
Member

@carolanitz carolanitz Jul 17, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Member

@carolanitz carolanitz Jul 17, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

@carolanitz carolanitz Jul 17, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Member

@carolanitz carolanitz Jul 17, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

link

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].
Copy link
Member

@carolanitz carolanitz Jul 17, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/>
Copy link
Member

@carolanitz carolanitz Jul 17, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would move most of them inline

@mkchoi212
Copy link
Contributor Author

mkchoi212 commented Jul 18, 2018

merged

@mkchoi212 mkchoi212 closed this Jul 18, 2018
@mkchoi212 mkchoi212 deleted the beginner branch July 18, 2018 12:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@carolanitz carolanitz carolanitz approved these changes

Assignees

No one assigned

Labels

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@mkchoi212 @carolanitz