aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/CODE_GUIDELINES.md2
-rw-r--r--docs/GIT-FU.md4
-rw-r--r--docs/README.Android.md9
-rw-r--r--docs/README.Linux.md2
-rw-r--r--docs/README.iOS.md8
-rw-r--r--docs/README.macOS.md2
-rw-r--r--docs/README.tvOS.md46
7 files changed, 36 insertions, 37 deletions
diff --git a/docs/CODE_GUIDELINES.md b/docs/CODE_GUIDELINES.md
index 49a30e66b2..c7cf298042 100644
--- a/docs/CODE_GUIDELINES.md
+++ b/docs/CODE_GUIDELINES.md
@@ -57,7 +57,7 @@
* [12.5. `for` loops](#125-for-loops)
* [12.6. Include guards](#126-include-guards)
* [12.7. Type aliases](#127-type-aliases)
- * [12.8. `goto`](#128goto)
+ * [12.8. `goto`](#128-goto)
* [12.9. Macros](#129-macros)
* [12.10. constexpr](#1210-constexpr)
* [12.11. `std::string` vs `std::string_view`](#1211-stdstring-vs-stdstring_view)
diff --git a/docs/GIT-FU.md b/docs/GIT-FU.md
index 1afcbf72d0..053de8297e 100644
--- a/docs/GIT-FU.md
+++ b/docs/GIT-FU.md
@@ -310,7 +310,7 @@ Fetch upstream changes and rebase feature branch on top of upstream master branc
Force push branch to remote origin:
![Rebase branch 03](resources/gitfu/rebase_branch_03.png)
-**[back to top](#table-of-contents)** | **[back to section top](#8-examples)** | **[back to subsection top](#81-rebase-branch)**
+**[back to top](#table-of-contents)** | **[back to section top](#8-examples-with-nice-screenies)** | **[back to subsection top](#81-rebase-branch)**
### 8.2. Fix commits
@@ -343,7 +343,7 @@ Finally, force push branch to remote origin:
**TIP**: It doesn't matter how many `fixup` commits you have on your feature branch. The only thing that matters is the number of the **first** commit with a `fixup` commit. If you're unsure of how many commits that is, issue `git log --pretty=oneline --abbrev-commit`, count from your **first commit** on the feature branch and use that number instead. In this example, that would be 28, e.g. `git rebase -i --autosquash HEAD~28`. `git` will take care of the rest automagically.
-**[back to top](#table-of-contents)** | **[back to section top](#8-examples)** | **[back to subsection top](#82-fix-commits)**
+**[back to top](#table-of-contents)** | **[back to section top](#8-examples-with-nice-screenies)** | **[back to subsection top](#82-fix-commits)**
## 9. Going pro
Got this far? Congrats! Now it gets fun!
diff --git a/docs/README.Android.md b/docs/README.Android.md
index b83c027911..1815ab8f65 100644
--- a/docs/README.Android.md
+++ b/docs/README.Android.md
@@ -3,17 +3,16 @@
# Android build guide
This guide has been tested with Ubuntu 16.04 (Xenial) x86_64. It is meant to cross-compile Kodi for Android using **[Kodi's unified depends build system](../tools/depends/README.md)**. Please read it in full before you proceed to familiarize yourself with the build procedure.
-It should work if you're using macOS. If that is the case, read **[macOS specific prerequisites](#35-macos-specific-prerequisites)** first.
+It should work if you're using macOS. If that is the case, read **[macOS specific prerequisites](#34-macos-specific-prerequisites)** first.
## Table of Contents
1. **[Document conventions](#1-document-conventions)**
2. **[Install the required packages](#2-install-the-required-packages)**
3. **[Prerequisites](#3-prerequisites)**
3.1. **[Extract Android SDK and NDK](#31-extract-android-sdk-and-ndk)**
- 3.2. **[Configure Android SDK](#32-configure-android-sdk)**
- 3.3. **[Set up the Android toolchain](#33-set-up-the-android-toolchain)**
- 3.4. **[Create a key to sign debug APKs](#34-create-a-key-to-sign-debug-apks)**
- 3.5. **[macOS specific prerequisites](#35-macos-specific-prerequisites)**
+ 3.2. **[Configure Android SDK](#32-configure-android-sdk)**
+ 3.3. **[Create a key to sign debug APKs](#33-create-a-key-to-sign-debug-apks)**
+ 3.4. **[macOS specific prerequisites](#34-macos-specific-prerequisites)**
4. **[Get the source code](#4-get-the-source-code)**
5. **[Build tools and dependencies](#5-build-tools-and-dependencies)**
5.1. **[Advanced Configure Options](#51-advanced-configure-options)**
diff --git a/docs/README.Linux.md b/docs/README.Linux.md
index 2789aae1a6..8c1946a225 100644
--- a/docs/README.Linux.md
+++ b/docs/README.Linux.md
@@ -124,7 +124,7 @@ Internal dependencies that are based on cmake upstream (currently crossguid, ffm
**Note:** fstrcmp requires libtool
-**[back to top](#table-of-contents)** | **[back to section top](#3-installing-the-required-packages)**
+**[back to top](#table-of-contents)** | **[back to section top](#3-install-the-required-packages)**
## 4. Build Kodi
### 4.1. Configure build
diff --git a/docs/README.iOS.md b/docs/README.iOS.md
index 2787e719cd..e168322eb9 100644
--- a/docs/README.iOS.md
+++ b/docs/README.iOS.md
@@ -8,12 +8,12 @@ This guide has been tested using Xcode 11.3.1 running on MacOS 10.14.4 (Mojave).
2. **[Prerequisites](#2-prerequisites)**
3. **[Get the source code](#3-get-the-source-code)**
4. **[Configure and build tools and dependencies](#4-configure-and-build-tools-and-dependencies)**
- 4.1. **[Advanced Configure Options](#41-Advanced-Configure-Options)**
+ 4.1. **[Advanced Configure Options](#41-advanced-configure-options)**
5. **[Build binary add-ons](#5-build-binary-add-ons)**
- 5.1. **[Independent Add-on building](#51-Independent-Add-on-building)**
- 5.2. **[Xcode project building](#52-Xcode-project-building)**
+ 5.1. **[Independent Add-on building](#51-independent-add-on-building)**
+ 5.2. **[Xcode project building](#52-xcode-project-building)**
6. **[Build Kodi](#6-build-kodi)**
- 6.1. **[Generate Project Files](#61-Generate-Project-Files)**
+ 6.1. **[Generate Project Files](#61-generate-project-files)**
6.2. **[Build with Xcode](#62-build)**
7. **[Package](#7-package)**
8. **[Install](#8-install)**
diff --git a/docs/README.macOS.md b/docs/README.macOS.md
index 5590e8a866..02913a9ae5 100644
--- a/docs/README.macOS.md
+++ b/docs/README.macOS.md
@@ -8,7 +8,7 @@ This guide has been tested using Xcode 11.3.1 running on MacOS 10.14.4 (Mojave).
2. **[Prerequisites](#2-prerequisites)**
3. **[Get the source code](#3-get-the-source-code)**
4. **[Configure and build tools and dependencies](#4-configure-and-build-tools-and-dependencies)**
- 4.1. **[Advanced Configure Options](#41-Advanced-Configure-Options)**
+ 4.1. **[Advanced Configure Options](#41-advanced-configure-options)**
5. **[Build binary add-ons](#5-build-binary-add-ons)**
6. **[Build Kodi](#6-build-kodi)**
6.1. **[Build with Xcode](#61-build-with-xcode)**
diff --git a/docs/README.tvOS.md b/docs/README.tvOS.md
index 032d69949e..185a6e4efe 100644
--- a/docs/README.tvOS.md
+++ b/docs/README.tvOS.md
@@ -8,22 +8,22 @@ This guide has been tested using Xcode 11.3.1 running on MacOS 10.15.2 (Catalina
2. **[Prerequisites](#2-prerequisites)**
3. **[Get the source code](#3-get-the-source-code)**
4. **[Configure and build tools and dependencies](#4-configure-and-build-tools-and-dependencies)**
- 4.1. **[Advanced Configure Options](#41-Advanced-Configure-Options)**
-5. **[Generate Kodi Build files](#5-Generate-Kodi-Build-files)**
- 5.1. **[Generate XCode Project Files](#51-Generate-Xcode-Project-Files)**
+ 4.1. **[Advanced Configure Options](#41-advanced-configure-options)**
+5. **[Generate Kodi Build files](#5-generate-kodi-build-files)**
+ 5.1. **[Generate XCode Project Files](#51-generate-xcode-project-files)**
5.2. **[Build with Xcode](#62-build)**
6. **[Build Kodi](#6-build-kodi)**
- 6.1. **[Build with Xcode](#61-Build-with-Xcode)**
- 6.2. **[Build with xcodebuild](#62-Build-with-xcodebuild)**
-7. **[Packaging to distribute as deb](#7-Packaging-to-distribute-as-deb)**
- 7.1. **[Package via Xcode](#71-Package-via-Xcode)**
- 7.2. **[Package via Xcodebuild](#72-Package-via-Xcodebuild)**
-8. **[Signing](#8-Signing)**
- 8.1. **[Signing using a developer account](#81-Signing-using-a-developer-account)**
- 8.2. **[Using iOS App Signer to install](#82-Using-iOS-App-Signer-to-install)**
-9. **[Install](#9-Install)**
- 9.1. **[Jailbroken devices](#91-Jailbroken-devices)**
- 9.2. **[Using Xcode to install](#92-Using-Xcode-to-install)**
+ 6.1. **[Build with Xcode](#61-build-with-xcode)**
+ 6.2. **[Build with xcodebuild](#62-build-with-xcodebuild)**
+7. **[Packaging to distribute as deb](#7-packaging-to-distribute-as-deb)**
+ 7.1. **[Package via Xcode](#71-package-via-xcode)**
+ 7.2. **[Package via Xcodebuild](#72-package-via-xcodebuild)**
+8. **[Signing](#8-signing)**
+ 8.1. **[Signing using a developer account](#81-signing-using-a-developer-account)**
+ 8.2. **[Using iOS App Signer to install](#82-using-ios-app-signer-to-install)**
+9. **[Install](#9-install)**
+ 9.1. **[Jailbroken devices](#91-jailbroken-devices)**
+ 9.2. **[Using Xcode to install](#92-using-xcode-to-install)**
## 1. Document conventions
This guide assumes you are using `terminal`, also known as `console`, `command-line` or simply `cli`. Commands need to be run at the terminal, one at a time and in the provided order.
@@ -186,7 +186,7 @@ make -j$(getconf _NPROCESSORS_ONLN)
## 5. Generate Kodi Build files
Before you can use Xcode to build Kodi, the Xcode project has to be generated with CMake. CMake is built as part of the dependencies and doesn't have to be installed separately. A toolchain file is also generated and is used to configure CMake.
-Default behaviour will not build binary addons. To add addons to your build go to **[Add Binary Addons to Project](#52-Add-Binary-Addons-to-Project)**
+Default behaviour will not build binary addons. To add addons to your build go to **[Add Binary Addons to Project](#52-add-binary-addons-to-project)**
## 5.1. Generate XCode Project Files
@@ -220,7 +220,7 @@ PROVISIONING_PROFILE_TOPSHELF - provprofile name for the top shelf
## 5.2. Add Binary Addons to Project
-**TIP:** If you wish to add signing settings automatically, look at **[Generate XCode Project Files](#51-Generate-XCode-Project-Files)** for the additional `CMAKE_EXTRA_ARGUMENTS`
+**TIP:** If you wish to add signing settings automatically, look at **[Generate XCode Project Files](#51-generate-xcode-project-files)** for the additional `CMAKE_EXTRA_ARGUMENTS`
You can find a complete list of available binary add-ons **[here](https://github.com/xbmc/repo-binary-addons)**.
@@ -248,13 +248,13 @@ You can also build the binary-addons target via xcodebuild. This will not build
```
xcodebuild -config "Debug" -target binary-addons
```
-**[back to top](#table-of-contents)** | **[back to section top](#5-Generate-Kodi-Build-files)**
+**[back to top](#table-of-contents)** | **[back to section top](#5-generate-kodi-build-files)**
## 6. Build
### 6.1. Build with Xcode
-Start Xcode, open the Kodi project file created in **[Generate Kodi Build files](#5-Generate-Kodi-Build-files)**
+Start Xcode, open the Kodi project file created in **[Generate Kodi Build files](#5-generate-kodi-build-files)**
**TIP:** (`kodi.xcodeproj`) is located in `$HOME/kodi-build`
@@ -281,14 +281,14 @@ This will create a `Kodi.app` file located in `$HOME/kodi-build/build/Debug-appl
**TIP:** You can specify Release instead of Debug as -config parameter.
**TIP:** If you build as a release target, the location of the `Kodi.app` will be `$HOME/kodi-build/build/Release-appletvos`
-**[back to top](#table-of-contents)** | **[back to section top](#6-Build)**
+**[back to top](#table-of-contents)** | **[back to section top](#6-build)**
## 7. Packaging to distribute as deb
CMake generates a target called `deb` which will package Kodi ready for distribution. After Kodi has been built, the target can be triggered by selecting it in Xcode active scheme or manually running
## 7.1. Package via Xcode
-Start Xcode, open the Kodi project file created in **[Generate XCode Project Files](#51-Generate-Project-Files)**
+Start Xcode, open the Kodi project file created in **[Generate XCode Project Files](#51-generate-xcode-project-files)**
**TIP:** (`kodi.xcodeproj`) is located in `$HOME/kodi-build`
@@ -312,7 +312,7 @@ xcodebuild -target deb
## 8. Signing
-**TIP:** If your device is jailbroken, you can go direct to **[Installing on Jailbroken Device](#91-Jailbroken-devices)**
+**TIP:** If your device is jailbroken, you can go direct to **[Installing on Jailbroken Device](#91-jailbroken-devices)**
## 8.1. Signing using a developer account
@@ -350,7 +350,7 @@ In that case Kodi will be sandboxed like any other app. All Kodi files are then
There are a number of different methods that can be used to install kodi on an AppleTV 4/4K.
## 9.1. Jailbroken devices
-On jailbroken devices the resulting deb file created from **[Packaging to distribute as deb](#7-Packaging-to-distribute-as-deb)** can be copied to the tvOS device via *ssh/scp* and installed manually. You need to SSH into the tvOS device and issue:
+On jailbroken devices the resulting deb file created from **[Packaging to distribute as deb](#7-packaging-to-distribute-as-deb)** can be copied to the tvOS device via *ssh/scp* and installed manually. You need to SSH into the tvOS device and issue:
```
dpkg -i <name of the deb file>
```
@@ -370,7 +370,7 @@ The Apple TV 4K cannot be connected to mac via a cable so the connection must be
6. Enter the verification code displayed on your AppleTV into the Device window pane for the device and click Connect.
Xcode sets up the Apple TV for wireless debugging and pairs with the device.
-Once your Apple TV has been connected in Xcode, you can deploy either the **[Deb](#7-Packaging-to-distribute-as-deb)** or **[App](#6-Build file)** file.
+Once your Apple TV has been connected in Xcode, you can deploy either the **[Deb](#7-packaging-to-distribute-as-deb)** or **[App](#6-build)** file.
1. Choose Window > Devices and Simulators, then in the window that appears, click Devices.
2. On your Mac, select the Apple TV in the Devices pane.
generated by cgit v1.2.3 (git 2.26.2) at 2024-11-27 18:29:53 +0000