diff options
| author | h.udo <hudokkow@gmail.com> | 2018-04-05 22:04:32 +0100 |
|---|---|---|
| committer | h.udo <hudokkow@gmail.com> | 2018-07-03 19:50:45 +0100 |
| commit | bb62d22f0d62b20ebc2325f7820a37759839efe0 (patch) | |
| tree | 60d6e9f4e3eb3a150b96bb204f97fd9b4479a2d1 /README.md | |
| parent | 40fe25d9c4890e6d64e74b70eecee84a82d04928 (diff) | |
[README] Kodi's codebase new face
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 89 |
1 files changed, 49 insertions, 40 deletions
@@ -1,54 +1,63 @@ -[](https://codedocs.xyz/xbmc/xbmc/) + - -# Kodi Home Theater Software +[](LICENSE.md) +[](http://hits.dwyl.io/xbmc/xbmc) +[](https://codedocs.xyz/xbmc/xbmc/) +[](https://github.com/xbmc/xbmc/pulls) +[](#how-to-contribute) +[](http://jenkins.kodi.tv/) +[](https://github.com/xbmc/xbmc/commits/master) -**Welcome to Kodi!** +# Welcome to Kodi Home Theater Software! +Kodi is an award-winning **free and open source** software media player and entertainment hub for digital media. Available as a native application for **Android, Linux, macOS, iOS and Windows operating systems**, Kodi runs on most common processor architectures. -Kodi is an award-winning free and open source (GPL) software media player and -entertainment hub for digital media. Kodi is available for multiple platforms. -Created in 2003 by a group of like minded programmers, Kodi is a non-profit -project run and developed by volunteers located around the world. -More than 450 software developers have contributed to Kodi to date, and 100-plus -translators have worked to expand its reach, making it available in more -than 70 languages. +Created in 2003 by a group of like minded programmers, Kodi is a non-profit project run by the XBMC Foundation and developed by volunteers located around the world. More than 500 software developers have contributed to Kodi to date, and 100-plus translators have worked to expand its reach, making it available in more than 70 languages. -While Kodi functions very well as a standard media player application for your -computer, it has been designed to be the perfect companion for your HTPC. -Supporting an almost endless range of remote controls, and combined with its -beautiful interface and powerful skinning engine, Kodi feels very natural to -use from the couch and is the ideal solution for your home theater. +While Kodi functions very well as a standard media player application for your computer, it has been designed to be the perfect companion for your HTPC. With its **beautiful interface and powerful skinning engine**, Kodi feels very natural to use from the couch with a remote control and is the ideal solution for your home theater. -Currently Kodi can be used to play almost all popular audio and video formats -around. It was designed for network playback, so you can stream your multimedia -from anywhere in the house or directly from the internet using practically any -protocol available. +## Give your media the love it deserves +Kodi can be used to play almost all popular audio and video formats around. It was designed for network playback, so you can stream your multimedia from anywhere in the house or directly from the internet using practically any protocol available. -Use your media as-is: Kodi can play CDs and DVDs directly -from the disk or image file, almost all popular archive formats from your hard -drive, and even files inside ZIP and RAR archives. It will even scan all of -your media and automatically create a personalized library complete with box -covers, descriptions, and fanart. There are playlist and slideshow functions, a -weather forecast feature and many audio visualizations. Once installed, your -computer will become a fully functional multimedia jukebox. +Point Kodi to your media and watch it **scan and automagically create a personalized library** complete with box covers, descriptions, and fanart. There are playlist and slideshow functions, a weather forecast feature and many audio visualizations. Once installed, your computer or HTPC will become a fully functional multimedia jukebox. +<p align="center"> + <img src="docs/resources/kodi.gif" alt="Kodi"> +</p> -## Installation +## Getting Started +Kodi's developers work hard to make it support a large range of devices and operating systems. We provide final as well as development builds. To get started, head over to the **[downloads section](https://kodi.tv/download)** and simply select the platform that you want to install it on. A **[quick start guide](https://kodi.wiki/view/quick_start_guide)** to help you get acquainted with Kodi is available in our wiki. -See [docs/README.xxx](https://github.com/xbmc/xbmc/tree/master/docs) for specific platform build information. +## How to Contribute +Kodi is created by users for users and **we welcome every contribution**. There are no highly paid developers or poorly paid support personnel on the phones ready to take your call. There are only users who have seen a problem and done their best to fix it. This means Kodi will always need the contributions of users like you. How can you get involved? -## Quick Kodi development links +* **Coding:** Developers can help Kodi by **[fixing a bug](https://trac.kodi.tv/)**, adding new features, making our technology smaller and faster and making development easier for others. Kodi's codebase consists mainly of C++ with small parts written in a variety of coding languages. Our add-ons mainly consist of python and XML. For more information, please have a look at our **[contributing guide](docs/CONTRIBUTING.md)**. +* **Helping users:** Our support process relies on enthusiastic contributors like you to help others get the most out of Kodi. The #1 priority is always answering questions in our **[support forums](https://forum.kodi.tv/)**. Everyday new people discover Kodi, and everyday they are virtually guaranteed to have questions. +* **Localization:** Translate **[Kodi](https://www.transifex.com/teamxbmc/kodi-main/)**, **[add-ons](https://www.transifex.com/teamxbmc/xbmc-addons/)** and **[skins](https://www.transifex.com/teamxbmc/xbmc-skins/)** into your native language. +* **Add-ons:** **[Add-ons](https://kodi.tv/addons)** are what make Kodi the most extensible and customizable entertainment hub available. **[Get started building an add-on](https://kodi.tv/create-an-addon)**. +* **Documentation:** Kodi's **[wiki pages](https://kodi.wiki/)** are the hub for information about Kodi and surrounding ecosystem. Help make our documentation better by writing new content or correcting existing material. -* [Contributing](https://github.com/xbmc/xbmc/blob/master/CONTRIBUTING.md) -* [Submitting a patch](http://kodi.wiki/view/HOW-TO_submit_a_patch) -* [Code guidelines](https://codedocs.xyz/xbmc/xbmc/code_guidelines.html) -* [Kodi development](http://kodi.wiki/view/Development) +**Not enough free time?** No problem! There are other ways to help Kodi. -## Useful links +* **Spread the word:** Share Kodi with the world! Tell your friends and family about how Kodi creates an amazing entertainment experience. Stay up to date on the latest stories about Kodi reading our **[news](https://kodi.tv/blog)** section, follow us on **[Twitter](https://twitter.com/koditv)** and **[Facebook](https://www.facebook.com/XBMC/)**, or **star Kodi's repo** if you want to follow development. +* **Donate:** We are always happy to receive a **[donation](https://kodi.tv/contribute/donate)**. Donations are typically used for travel to attend conferences, any necessary paperwork and legal fees, and the yearly XBMC Foundation Developers Conference, where a great deal of coding and planning for the following year occurs. Donations may also be used to purchase necessary hardware and licenses for developers, along with t-shirts, stickers, and other accessories for conferences. +* **Buy Kodi merchandise:** Purchasing Kodi gear helps just as much as a donation, and you get something in return! Checkout our **[store](https://kodi.tv/store)** for Kodi branded gear. We regularly add new products so check back often. -* [Kodi wiki](http://kodi.wiki/) -* [Kodi bug tracker](http://trac.kodi.tv) -* [Kodi community forums](http://forum.kodi.tv/) -* [Kodi website](http://kodi.tv) +## Building +Kodi uses CMake as its building system but instructions are highly dependent on your operating system and target platform. Fortunately **[we've got you covered](docs/README.md)**. -**Enjoy Kodi and help us improve it today. :)** +## Acknowledgements +Kodi couldn't exist without + +* All the **[contributors](https://github.com/xbmc/xbmc/graphs/contributors)**. Big or small a change, it does make a difference. +* All the developers that write the fantastic **software and libraries** that Kodi uses. We stand on the shoulders of giants. +* Our **[fantastic community](https://forum.kodi.tv/)** for the never ending support, inspiration, feedback, and for keeping us on our toes when we screw up! +* **[Our sponsors](https://kodi.tv/sponsors)**. Without them, keeping a huge project like this alive would be next to impossible. + +## License +Kodi is **[GPLv2 licensed](LICENSE.md)**. You may use, distribute and copy it under the license terms. + +<a href="https://github.com/xbmc/xbmc/graphs/contributors"><img src="https://forthebadge.com/images/badges/built-by-developers.svg" height="25"></a> +<a href="https://github.com/xbmc/xbmc"><img src="https://forthebadge.com/images/badges/certified-cousin-terio.svg" height="25"></a> +<a href="https://github.com/xbmc/xbmc"><img src="https://forthebadge.com/images/badges/approved-by-george-costanza.svg" height="25"></a> +<a href="https://kodi.tv/download"><img src="https://forthebadge.com/images/badges/check-it-out.svg" height="25"></a> +<a href="https://github.com/xbmc/xbmc"><img src="https://forthebadge.com/images/badges/winter-is-coming.svg" height="25"></a> |