summaryrefslogtreecommitdiffstats
path: root/docs/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-10 18:07:22 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-10 18:07:22 +0000
commitc04dcc2e7d834218ef2d4194331e383402495ae1 (patch)
tree7333e38d10d75386e60f336b80c2443c1166031d /docs/README.md
parentInitial commit. (diff)
downloadkodi-c04dcc2e7d834218ef2d4194331e383402495ae1.tar.xz
kodi-c04dcc2e7d834218ef2d4194331e383402495ae1.zip
Adding upstream version 2:20.4+dfsg.upstream/2%20.4+dfsg
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..836f1c3
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,23 @@
+![Kodi Logo](resources/banner_slim.png)
+
+# Kodi's Documentation Home
+Welcome to Kodi's documentation home. Geared at developers, it contains platform specific build guides, **[code guidelines](CODE_GUIDELINES.md)**, a **[git guide](GIT-FU.md)** streamlined for Kodi's workflow and Doxygen's resources, ready to generate **[code documentation](doxygen/README.md)**.
+
+If you haven't done so, we encourage you to read our **[contributing guide](CONTRIBUTING.md)** first. It contains pertinent information about our development model.
+
+## Building Kodi
+Kodi uses CMake as its building system but instructions are highly dependent on your operating system and target platform. Choose your platform below and read the guide carefully before proceeding.
+
+<p align="center">
+ <a href="README.Android.md" title="Android"><img src="resources/android.svg" height="78"></a>
+ <a href="README.Fedora.md" title="Fedora"><img src="resources/fedora.svg" height="78"></a>
+ <a href="README.FreeBSD.md" title="FreeBSD"><img src="resources/freebsd.svg" height="78"></a>
+ <a href="README.iOS.md" title="iOS"><img src="resources/ios.svg" height="78"></a>
+ <a href="README.Linux.md" title="Linux"><img src="resources/linux.svg" height="78"></a>
+ <a href="README.macOS.md" title="macOS"><img src="resources/macos.svg" height="78"></a>
+ <a href="README.openSUSE.md" title="openSUSE"><img src="resources/opensuse.svg" height="78"></a>
+ <a href="README.tvOS.md" title="tvOS"><img src="resources/tvos.svg" height="78"></a>
+ <a href="README.Ubuntu.md" title="Ubuntu"><img src="resources/ubuntu.svg" height="78"></a>
+ <a href="README.Windows.md" title="Windows"><img src="resources/windows.svg" height="78"></a>
+</p>
+