aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authoruNiversaI <uNiversaI@noreply.github.com>2014-10-04 02:01:44 +0900
committeruNiversaI <uNiversaI@noreply.github.com>2014-10-04 02:02:21 +0900
commitc2d8eced5083fc7e19e8b2d88bf3ba4e53b44e81 (patch)
tree51bd50df52a7bbd85ba72a00d48ad90b49471261 /README.md
parentd27086f71f32820589bf5ccb4b085b58a7b05ad9 (diff)
[readme] update master github README
This updates the master github readme to github markdown aside from formatting added basic links and info.
Diffstat (limited to 'README.md')
-rw-r--r--README.md48
1 files changed, 48 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..51bfa193da
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+#### About
+
+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 65 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.
+
+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.
+
+Use your media as-is: Kodi can play CD's and DVD's 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.
+
+***
+
+##### Installation
+
+See [docs/README.xxx] (https://github.com/xbmc/xbmc/tree/master/docs) for specific platform build information.
+
+##### Quick Kodi development links
+
+* [Submitting a patch] (http://wiki.xbmc.org/index.php?title=HOW-TO_submit_a_patch)
+* [Coding guidelines] (http://forum.xbmc.org/showthread.php?tid=5238)
+* [Kodi development] (http://wiki.xbmc.org/index.php?title=XBMC_development)
+
+##### Useful links
+
+* [Kodi wiki] (http://wiki.xbmc.org/)
+* [Kodi community forums] (http://forum.xbmc.org/)
+* [Kodi website] (http://kodi.tv)
+
+#### Enjoy Kodi and help us improve it today. :)