You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: LICENSES/README.md
+2-1
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,8 @@ Since most source files in Kodi are `GPL-2.0-or-later` licensed, the typical cop
43
43
*/
44
44
```
45
45
46
-
**NOTE:** Kodi is developed and maintained by Kodi Team members and the open-source community. We thank all of our **[contributors](https://github.com/xbmc/xbmc/graphs/contributors)**! **For the detailed history of contributions** of a given file, use `git blame <filename>` to see line-by-line credits or `git log --follow <filename>` to see the changelog across renames, rewrites and code shuffle.
46
+
> [!NOTE]
47
+
> Kodi is developed and maintained by Kodi Team members and the open-source community. We thank all of our **[contributors](https://github.com/xbmc/xbmc/graphs/contributors)**! **For the detailed history of contributions** of a given file, use `git blame <filename>` to see line-by-line credits or `git log --follow <filename>` to see the changelog across renames, rewrites and code shuffle.
47
48
48
49
### License Files
49
50
All SPDX license identifiers must have a corresponding file in the **LICENSES** subdirectory. This is required to allow tool verification (e.g. **[ScanCode toolkit](https://github.com/nexB/scancode-toolkit)**) and to have the licenses ready to read and extract right from the source, which is recommended by various FOSS organizations, e.g. the **[FSFE REUSE Initiative](https://reuse.software/)**.
Several different strategies are used to draw your attention to certain pieces of information. In order of how critical the information is, these items are marked as a note, tip, or warning. For example:
88
88
89
-
**NOTE:** Linux is user friendly... It's just very particular about who its friends are.
90
-
**TIP:** Algorithm is what developers call code they do not want to explain.
91
-
**WARNING:** Developers don't change light bulbs. It's a hardware problem.
89
+
> [!NOTE]
90
+
> Linux is user friendly... It's just very particular about who its friends are.
91
+
92
+
> [!TIP]
93
+
> Algorithm is what developers call code they do not want to explain.
94
+
95
+
> [!WARNING]
96
+
> Developers don't change light bulbs. It's a hardware problem.
92
97
93
98
**[back to top](#table-of-contents)** | **[back to section top](#2-document-conventions)**
94
99
@@ -121,7 +126,8 @@ cd kodi // change to the newly
121
126
git remote add upstream https://github.com/xbmc/xbmc.git // assign Kodi's main repo to a remote
122
127
```
123
128
124
-
**TIP:** Windows users should use `cd %userprofile%` instead.
129
+
> [!TIP]
130
+
> Windows users should use `cd %userprofile%` instead.
125
131
126
132
From this point forward, every command shown assumes you're inside `$HOME/kodi` or `%userprofile%\kodi` if you're a Windows user. To get there, issue:
127
133
```
@@ -197,7 +203,8 @@ Delete remote branch:
197
203
git push origin -d <feature-branch>
198
204
```
199
205
200
-
**WARNING:** Be careful deleting branches. Make sure you don't need them anymore.
206
+
> [!WARNING]
207
+
> Be careful deleting branches. Make sure you don't need them anymore.
git push origin // push updated feature branch to your personal remote repo
237
244
```
238
245
239
-
**WARNING:** Be **very careful** updating to and from origin. It can cause loss of work, specially if you work on more than one machine. Make sure your remote origin repo **always** holds the most up-to-date version of your code. **No, seriously**. Make a mental rule: *remote origin repo always holds the most up-to-date version of my code!* and **stick to it!** It's almost always possible to recover lost work with `git` but it's hard and unnecessary work if you follow some simple rules.
246
+
> [!WARNING]
247
+
> Be **very careful** updating to and from origin. It can cause loss of work, specially if you work on more than one machine. Make sure your remote origin repo **always** holds the most up-to-date version of your code. **No, seriously**. Make a mental rule: *remote origin repo always holds the most up-to-date version of my code!* and **stick to it!** It's almost always possible to recover lost work with `git` but it's hard and unnecessary work if you follow some simple rules.
240
248
241
249
**[back to top](#table-of-contents)** | **[back to section top](#6-syncing-branches)**
Several different strategies are used to draw your attention to certain pieces of information. In order of how critical the information is, these items are marked as a note, tip, or warning. For example:
50
50
51
-
**NOTE:** Linux is user friendly... It's just very particular about who its friends are.
52
-
**TIP:** Algorithm is what developers call code they do not want to explain.
53
-
**WARNING:** Developers don't change light bulbs. It's a hardware problem.
51
+
> [!NOTE]
52
+
> Linux is user friendly... It's just very particular about who its friends are.
53
+
54
+
> [!TIP]
55
+
> Algorithm is what developers call code they do not want to explain.
56
+
57
+
> [!WARNING]
58
+
> Developers don't change light bulbs. It's a hardware problem.
54
59
55
60
**[back to top](#table-of-contents)** | **[back to section top](#1-document-conventions)**
56
61
@@ -59,9 +64,11 @@ Install build dependencies needed to cross-compile Kodi for Android:
**NOTE:** If you're running a 32bit Debian/Ubuntu distribution, remove `lib32stdc++6 lib32z1 lib32z1-dev` from the command.
63
-
**NOTE:** Gradle 7.0.2+ requires Jave Runtime 11+. Check java version by running `java --version`. If version is < 11, set JAVA_HOME to java 11+ home directory._
67
+
> [!NOTE]
68
+
> If you're running a 32bit Debian/Ubuntu distribution, remove `lib32stdc++6 lib32z1 lib32z1-dev` from the command.
64
69
70
+
> [!NOTE]
71
+
> Gradle 7.0.2+ requires Jave Runtime 11+. Check java version by running `java --version`. If version is < 11, set JAVA_HOME to java 11+ home directory._
65
72
66
73
**[back to top](#table-of-contents)**
67
74
@@ -82,7 +89,8 @@ Extract Android SDK Command line tools:
> **Note:** Android x86 and x86_64 are not maintained and are not 100% sure that everything works correctly!
156
+
> [!NOTE]
157
+
> Android x86 and x86_64 are not maintained and are not 100% sure that everything works correctly!
148
158
149
159
Build tools and dependencies:
150
160
```
151
161
make -j$(getconf _NPROCESSORS_ONLN)
152
162
```
153
163
154
-
**TIP:** By adding `-j<number>` to the make command, you can choose how many concurrent jobs will be used and expedite the build process. It is recommended to use `-j$(getconf _NPROCESSORS_ONLN)` to compile on all available processor cores. The build machine can also be configured to do this automatically by adding `export MAKEFLAGS="-j$(getconf _NPROCESSORS_ONLN)"` to your shell config (e.g. `~/.bashrc`).
164
+
> [!TIP]
165
+
> By adding `-j<number>` to the make command, you can choose how many concurrent jobs will be used and expedite the build process. It is recommended to use `-j$(getconf _NPROCESSORS_ONLN)` to compile on all available processor cores. The build machine can also be configured to do this automatically by adding `export MAKEFLAGS="-j$(getconf _NPROCESSORS_ONLN)"` to your shell config (e.g. `~/.bashrc`).
155
166
156
-
**WARNING:** Look for the `Dependencies built successfully.` success message. If in doubt run a single threaded `make` command until the message appears. If the single make fails, clean the specific library by issuing `make -C target/<name_of_failed_lib> distclean` and run `make`again.
167
+
> [!WARNING]
168
+
> Look for the `Dependencies built successfully.` success message. If in doubt run a single threaded `make` command until the message appears. If the single make fails, clean the specific library by issuing `make -C target/<name_of_failed_lib> distclean` and run `make`again.
157
169
158
170
### 5.1. Advanced Configure Options
159
171
@@ -280,7 +292,9 @@ cd $HOME/kodi
280
292
make -C tools/depends/target/cmakebuildsys
281
293
```
282
294
283
-
**TIP:** BUILD_DIR can be provided as an argument to cmakebuildsys. This allows you to provide an alternate build location. Change all paths onwards as required if BUILD_DIR option used.
295
+
> [!TIP]
296
+
> BUILD_DIR can be provided as an argument to cmakebuildsys. This allows you to provide an alternate build location. Change all paths onwards as required if BUILD_DIR option used.
297
+
284
298
```
285
299
mkdir $HOME/kodi-build
286
300
make -C tools/depends/target/cmakebuildsys BUILD_DIR=$HOME/kodi-build
@@ -358,7 +372,8 @@ Enable CheckJNI (**before** starting the Kodi):
358
372
adb shell setprop debug.checkjni 1
359
373
```
360
374
361
-
**NOTE:** These commands assume that current directory is `$HOME/kodi-build/tools/android/packaging` and that the proper SDK/NDK paths are set.
375
+
> [!NOTE]
376
+
> These commands assume that current directory is `$HOME/kodi-build/tools/android/packaging` and that the proper SDK/NDK paths are set.
362
377
363
378
GDB can be used to debug, though the support is rather primitive. Rather than using `gdb` directly, you will need to use `ndk-gdb` which wraps it. You can use the `-p/--project` switches or instead you will need to `cd` to `$HOME/kodi-build/tools/android/packaging/xbmc` and execute it from there.
Several different strategies are used to draw your attention to certain pieces of information. In order of how critical the information is, these items are marked as a note, tip, or warning. For example:
40
40
41
-
**NOTE:** Linux is user friendly... It's just very particular about who its friends are.
42
-
**TIP:** Algorithm is what developers call code they do not want to explain.
43
-
**WARNING:** Developers don't change light bulbs. It's a hardware problem.
41
+
> [!NOTE]
42
+
> Linux is user friendly... It's just very particular about who its friends are.
43
+
44
+
> [!TIP]
45
+
> Algorithm is what developers call code they do not want to explain.
46
+
47
+
> [!WARNING]
48
+
> Developers don't change light bulbs. It's a hardware problem.
44
49
45
50
**[back to top](#table-of-contents)** | **[back to section top](#1-document-conventions)**
If you get a `package not found` type of message with the below command, remove the offending package(s) from the install list and reissue the command. Take a note of the missing dependencies and, after a successful step completion, **[build the missing dependencies manually](README.Linux.md#31-build-missing-dependencies)**.
63
68
64
-
**NOTE:** Kodi requires a compiler with C++17 support, i.e. gcc >= 7 or clang >= 5
69
+
> [!NOTE]
70
+
> Kodi requires a compiler with C++17 support, i.e. gcc >= 7 or clang >= 5
**WARNING:** Make sure you copy paste the entire line or you might receive an error or miss a few dependencies.
77
+
> [!WARNING]
78
+
> Make sure you copy paste the entire line or you might receive an error or miss a few dependencies.
72
79
73
80
Building for Wayland requires some extra packages:
74
81
```
@@ -85,14 +92,16 @@ Optional packages that you might want to install for extra functionality (genera
85
92
sudo dnf install doxygen mariadb-devel
86
93
```
87
94
88
-
**NOTE:** For developers and anyone else who builds frequently it is recommended to install `ccache` to expedite subsequent builds of Kodi.
95
+
> [!NOTE]
96
+
> For developers and anyone else who builds frequently it is recommended to install `ccache` to expedite subsequent builds of Kodi.
89
97
90
98
You can install it with:
91
99
```
92
100
sudo dnf install ccache
93
101
```
94
102
95
-
**TIP:** If you have multiple computers at home, `distcc` will distribute build workloads of C and C++ code across several machines on a network. Team Kodi may not be willing to give support if problems arise using such a build configuration.
103
+
> [!TIP]
104
+
> If you have multiple computers at home, `distcc` will distribute build workloads of C and C++ code across several machines on a network. Team Kodi may not be willing to give support if problems arise using such a build configuration.
0 commit comments