Improve README

Fix typos, grammar in README.md. Add links too.
2024-11-28 12:26:11 +08:00 · 2021-05-30 13:17:59 +00:00 · 2021-05-30 13:17:59 +00:00 · 3d07a3d41f
commit 3d07a3d41f
parent 94d04d840a
1 changed files with 42 additions and 32 deletions
--- a/README.md
+++ b/README.md
@ -3,57 +3,64 @@
 **VLC** is a libre and open source **media player** and **multimedia engine**,
 focused on **playing everything**, and **running everywhere**.

-**VLC** can play most multimedia files, discs, streams, devices and is able to
+**VLC** can play most multimedia files, discs, streams, devices and is also able to
 convert, encode, **stream** and manipulate streams into numerous formats.

 VLC is used by many over the world, on numerous platforms, for very different use cases.

-The **engine of VLC** can be embedded by 3rd party applications, and is called *libVLC*.
+The **engine of VLC** can be embedded into 3rd party applications, and is called *libVLC*.

 **VLC** is part of the [VideoLAN project](https://videolan.org) and
 is developed and supported by a community of volunteers.

 The VideoLAN project was started at the university [École Centrale Paris](https://www.centralesupelec.fr/) who
 relicensed VLC under the GPLv2 license in February 2001. Since then, VLC has
-been downloaded multi-billion times.
+been downloaded **billions** of times.

 ## License

 **VLC** is released under the GPLv2 *(or later)* license.
-*On some platforms, it is de facto GPLv3, because of dependencies licenses*.
+*On some platforms, it is de facto GPLv3, because of the licenses of dependencies*.

 **libVLC**, the engine is released under the LGPLv2 *(or later)* license. \
 This allows embedding the engine in 3rd party applications, while letting them to be licensed under other licenses.

 # Platforms

-VLC is available on the following platforms:
- Windows *(from 7 to all versions of 10)*, including UWP platforms
- macOS *(10.10 and more recent)*
- GNU/Linux and affiliated
+VLC is available for the following platforms:
+- [Windows] *(from 7 and later, including UWP platforms and all versions of Windows 10)*
+- [macOS] *(10.10 and later)*
+- [GNU/Linux] and affiliated
 - \*BSD and affiliated
- Android *(4.2 and more recent)*, including Android TV and Android Auto
- iOS *(9 and more recent)*, including AppleTV and iPadOS
+- [Android] *(4.2 and later)*, including Android TV and Android Auto
+- [iOS] *(9 and later)*, including AppleTV and iPadOS
 - Haiku, OS/2 and a few others.

+[Windows]: https://www.videolan.org/vlc/download-windows.html
+[macOS]: https://www.videolan.org/vlc/download-macosx.html
+[GNU/Linux]: https://www.videolan.org/vlc/#download
+[Android]: https://www.videolan.org/vlc/download-android.html
+[iOS]: https://www.videolan.org/vlc/download-ios.html
+
 Not all platforms receive the same amount of care, due to our limited resources.

-**Nota Bene**: [Android repository](https://code.videolan.org/videolan/vlc-android/) and
-[iOS repository](https://code.videolan.org/videolan/vlc-ios/) are on different repository
+**Nota Bene**: The [Android app](https://code.videolan.org/videolan/vlc-android/) and
+the [iOS app](https://code.videolan.org/videolan/vlc-ios/) are located in different repositories
 than the main one.

 # Contributing & Community

 **VLC** is maintained by a community of people, and VideoLAN is not paying any of them.\
 The community is composed of developers, helpers, maintainers, designers and writers that want
-the open source project to thrive.
+this open source project to thrive.

-The main development of VLC is done in the C language, but this repository has also plenty of C++, Obj-C, asm, Rust.
+The main development of VLC is done in the C language, but this repository also contains
+plenty of C++, Obj-C, asm and Rust.

-Other repositories linked to vlc are done in Kotlin/Java [(Android)](https://code.videolan.org/videolan/vlc-android/),
-in Swift [(iOS)](https://code.videolan.org/videolan/vlc-ios/), C# [(libVLCSharp)](https://code.videolan.org/videolan/libvlcsharp/)
+Other repositories linked to vlc are done in languages including Kotlin/Java [(Android)](https://code.videolan.org/videolan/vlc-android/),
+Swift [(iOS)](https://code.videolan.org/videolan/vlc-ios/), and C# [(libVLCSharp)](https://code.videolan.org/videolan/libvlcsharp/).

-We need help for the following tasks:
+We need help with the following tasks:
 - coding
 - packaging for Windows, macOS and Linux distributions
 - technical writing for the documentation
@ -61,39 +68,42 @@ We need help for the following tasks:
 - support
 - community management and communication.

-Please reach us :)
+Please contribute :)

-We are on IRC, on the **#videolan** channel on *Freenode*.
+We are on IRC. You can find us on the **#videolan** channel on *[Libera.chat]*.
+
+[Libera.chat]: https://libera.chat

 ## Contributions

-Contributions are now done through Merge Requests on our [gitlab repository](https://code.videolan.org/videolan/vlc/).
+Contributions are now done through Merge Requests on our [GitLab repository](https://code.videolan.org/videolan/vlc/).

-CI, Discussions should be resolved before merging a Merge Request.
+CI and discussions should be resolved before a Merge Request can be merged.

 # libVLC

 **libVLC** is an embeddable engine for 3rd party applications and frameworks.

-It runs on the same platforms of VLC *(and sometimes on more platforms)* and can provide playback,
-streaming and converting of multimedia files and stream.
+It runs on the same platforms as VLC *(and sometimes on more)* and can provide playback,
+streaming and converting of multimedia files and streams.

-**libVLC** has numerous bindings for other languagues, like C++, Python or C#.
+
+**libVLC** has numerous bindings for other languages, like C++, Python and C#.

 # Support

 ## Links

-You can found here several links that might help you:
+Some useful links that might help you:

- [The VLC web site](http://www.videolan.org/vlc/)
+- [VLC web site](http://www.videolan.org/vlc/)
 - [Support](https://www.videolan.org/support/)
 - [Forums](https://forum.videolan.org/)
 - [Wiki](https://wiki.videolan.org/)
- [The Developers site](https://wiki.videolan.org/Developers_Corner)
+- [Developer's Corner](https://wiki.videolan.org/Developers_Corner)
 - [VLC hacking guide](https://wiki.videolan.org/Hacker_Guide)
 - [Bugtracker](https://code.videolan.org/videolan/vlc/-/issues)
- [The VideoLAN web site](https://www.videolan.org/)
+- [VideoLAN web site](https://www.videolan.org/)

 ## Source Code sitemap
 ```
@ -103,7 +113,7 @@ COPYING            - The GPL license.
 COPYING.LIB        - The LGPL license.
 INSTALL            - Installation and building instructions.
 NEWS               - Important modifications between the releases.
-README             - This file.
+README             - Project summary.
 THANKS             - VLC contributors.

 bin/               - VLC binaries.
@ -114,7 +124,7 @@ contrib/           - Facilities for retrieving external libraries and building
                     them for systems that don't have the right versions.
 doc/               - Miscellaneous documentation.
 extras/analyser    - Code analyser and editor specific files.
-extras/buildsystem - different buildsystems specific files.
+extras/buildsystem - Different build system specific files.
 extras/misc        - Files that don't fit in the other extras/ categories.
 extras/package     - VLC packaging specific files such as spec files.
 extras/tools/      - Facilities for retrieving external building tools needed
@ -123,8 +133,8 @@ include/           - Header files.
 lib/               - libVLC source code.
 modules/           - VLC plugins and modules. Most of the code is here.
 po/                - VLC translations.
-share/             - Common Resources files.
+share/             - Common resource files.
 src/               - libvlccore source code.
-test/              - testing system.
+test/              - Testing system.
 ```