aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMemphiz <memphis@machzwo.de>2014-10-30 15:13:27 +0100
committerMemphiz <memphis@machzwo.de>2014-10-30 15:13:27 +0100
commit5ba4d5f056b30e3d9bd125dc1862b95b6fc29df3 (patch)
tree96c0d41d36cea679a8ab86bd5d554707a6cd598a /docs
parent322bd11f90fbdbcaa04100f58833470ffe1b1438 (diff)
parent72158c5bab02c8cadabd0c155f42a94aa93cf386 (diff)
Merge pull request #5606 from yanniks/readmeother
README fixes and rebranding
Diffstat (limited to 'docs')
-rw-r--r--docs/README.android52
-rw-r--r--docs/README.armel38
-rw-r--r--docs/README.raspberrypi12
3 files changed, 51 insertions, 51 deletions
diff --git a/docs/README.android b/docs/README.android
index 2f8908c112..dcb9382b29 100644
--- a/docs/README.android
+++ b/docs/README.android
@@ -4,8 +4,8 @@ TOC
3. Getting the source code
4. Installing the required Ubuntu packages
5. How to compile
-6. Installing XBMC in an Android system
-7. Running and debugging XBMC in an Android system
+6. Installing Kodi in an Android system
+7. Running and debugging Kodi in an Android system
8. Architecture
9. Useful Commands
@@ -25,7 +25,7 @@ character itself should NOT be typed as part of the command.
-----------------------------------------------------------------------------
2. Installing the required Ubuntu packages
-----------------------------------------------------------------------------
-These are the minimum packages necessary for building XBMC. Non-Ubuntu
+These are the minimum packages necessary for building Kodi. Non-Ubuntu
users will need to get the equivalents.
# sudo apt-get install build-essential default-jdk git curl autoconf \
@@ -34,7 +34,7 @@ users will need to get the equivalents.
If you run a 64bit operating system you will also need to get ia32-libs
ubuntu >= 14.04:
- # sudo apt-get install lib32stdc++6 lib32z1 lib32z1-de
+ # sudo apt-get install lib32stdc++6 lib32z1 lib32z1-dev
older versions:
# sudo apt-get install ia32-libs
@@ -50,7 +50,7 @@ JRE: openjre-6-jre (java version "1.6.0_27")
3. Installing and setting up the Android environment
-----------------------------------------------------------------------------
-To develop XBMC for Android the Android SDK and NDK are required.
+To develop Kodi for Android the Android SDK and NDK are required.
--------------------------------------------------------------------
3.1. Getting the Android SDK and NDK
@@ -60,7 +60,7 @@ To get the Android SDK, go to http://developer.android.com/sdk and
download the latest version for your operating system. The NDK
can be downloaded from http://developer.android.com/tools/sdk/ndk/
-[NOTICE] Compiling XBMC for Android requires Android NDK
+[NOTICE] Compiling Kodi for Android requires Android NDK
Revision r9. For the SDK just use the latest available.
It will work.
@@ -97,7 +97,7 @@ install some android packages using the Android SDK Manager:
3.3. Setup the Android toolchain
--------------------------------------------------------------------
-To be able to compile XBMC and the libraries it depends on for the
+To be able to compile Kodi and the libraries it depends on for the
Android platform you first need to setup an Android toolchain using
the Android NDK which you earlier extracted to <android-ndk>. The
following commands will create a toolchain suitable for the most
@@ -105,7 +105,7 @@ common scenario.
The --install-dir option (and therefore the <android-toolchain-arm>/<android-toolchain-x86> value)
specifies where the resulting toolchain should be installed (your choice).
-[NOTICE] XBMC uses the android API Version 14 and gcc version 4.8!
+[NOTICE] Kodi uses the android API Version 14 and gcc version 4.8!
Building for arm architecture:
@@ -144,15 +144,15 @@ Make sure to pick a toolchain for your desired architecture.
-----------------------------------------------------------------------------
# cd $HOME
- # git clone git://github.com/xbmc/xbmc.git xbmc-android
- # cd xbmc-android
+ # git clone git://github.com/xbmc/xbmc.git kodi-android
+ # cd kodi-android
# git submodule update --init addons/skin.re-touched
-----------------------------------------------------------------------------
5. How to compile
-----------------------------------------------------------------------------
-Compiling XBMC for Android consists of compiling the libraries XBMC depends
+Compiling Kodi for Android consists of compiling the libraries Kodi depends
on with the Android toolchain and creating an Android Application Package
(APK) which can be installed in an Android system.
@@ -160,7 +160,7 @@ on with the Android toolchain and creating an Android Application Package
5.1. Building dependencies
--------------------------------------------------------------------
- # cd $HOME/xbmc-android/tools/depends
+ # cd $HOME/kodi-android/tools/depends
# ./bootstrap
# ./configure --help
@@ -182,10 +182,10 @@ on with the Android toolchain and creating an Android Application Package
"Dependencies built successfully." appears.
--------------------------------------------------------------------
-5.2. Building XBMC
+5.2. Building Kodi
--------------------------------------------------------------------
- # cd $HOME/xbmc-android
+ # cd $HOME/kodi-android
# make -C tools/depends/target/xbmc
# make
# make apk
@@ -194,15 +194,15 @@ on with the Android toolchain and creating an Android Application Package
subsequent builds can be run with a simple 'make' and 'make apk'.
-----------------------------------------------------------------------------
-6. Installing XBMC in an Android system
+6. Installing Kodi in an Android system
-----------------------------------------------------------------------------
-To install XBMC through the previously built APK in an Android system you can
+To install Kodi through the previously built APK in an Android system you can
either install it on a real device (smartphone/tablet/...) running Android
>= 2.3.x.
--------------------------------------------------------------------
-6.1. Installing XBMC on the Android device
+6.1. Installing Kodi on the Android device
--------------------------------------------------------------------
Make sure your Android device is connected to your computer through
@@ -212,7 +212,7 @@ device's Android settings:
- Applications
[X] Unknown sources
- # cd $HOME/xbmc-android/tools/android/packaging
+ # cd $HOME/kodi-android/tools/android/packaging
# adb devices
# adb -s <device-id> install -r images/xbmcapp-debug.apk
@@ -221,17 +221,17 @@ The <device-id> can be retrieved from the list returned by the
your device.
-----------------------------------------------------------------------------
-7. Running and debugging XBMC in an Android system
+7. Running and debugging Kodi in an Android system
-----------------------------------------------------------------------------
-After installing XBMC's APK in an Android system you can start it using its
+After installing Kodi's APK in an Android system you can start it using its
Launcher icon in Android's Application Launcher.
--------------------------------------------------------------------
-7.1. Debugging XBMC
+7.1. Debugging Kodi
--------------------------------------------------------------------
-To be able to see what is happening while running XBMC you first need
+To be able to see what is happening while running Kodi you first need
to enable USB debugging in your Android settings (this is already done
when using the emulator):
@@ -257,14 +257,14 @@ to cd to tools/android/packaging/xbmc and execute it from there.
# ndk-gdb --start --delay=0
-This will open the installed version of XBMC and break. The warnings can be
+This will open the installed version of Kodi and break. The warnings can be
ignored as we have setup the appropriate paths already.
--------------------------------------------------------------------
8. Architecture
--------------------------------------------------------------------
-During the early days of the android port, xbmc was launched via a stub lib
+During the early days of the android port, Kodi was launched via a stub lib
that then dlopen'd libkodi. This was done to get around bionic's poor handling
of shared libs. We now compile everything into libkodi itself so that it has
no runtime dependencies beyond system libs. Done this way, we're able to launch
@@ -317,10 +317,10 @@ is 'tools/android/packaging' and that the proper sdk/ndk paths are set.
-Install a new build over the existing one
# adb -e install -r images/xbmcapp-debug.apk
--Launch XBMC on the emulator without the GUI
+-Launch Kodi on the emulator without the GUI
# adb shell am start -a android.intent.action.MAIN -n org.xbmc.xbmc/android.app.NativeActivity
--Kill a misbehaving XBMC
+-Kill a misbehaving Kodi
# adb shell ps | grep org.xbmc | awk '{print $2}' | xargs adb shell kill
-Filter logcat messages by a specific tag (e.g. "XBMC")
diff --git a/docs/README.armel b/docs/README.armel
index 066cc0887d..1ad32fe908 100644
--- a/docs/README.armel
+++ b/docs/README.armel
@@ -14,7 +14,7 @@ TOC
7. How to run
7.1 Obtaining the Packages
7.2 Installing the Files
- 7.3 Running XBMC
+ 7.3 Running Kodi
8. Troubleshooting
@@ -22,12 +22,12 @@ TOC
1. Introduction
-----------------------------------------------------------------------------
-This is a port of XBMC for use on ARM Architecture.
-As this is not an official version of XBMC, in-depth testing on various setups has not been done. USE WITH CAUTION!
+This is a port of Kodi for use on ARM Architecture.
+As this is not an official version of Kodi, in-depth testing on various setups has not been done. USE WITH CAUTION!
For the purpose of this port, the following Hardware and Software was used.
Software: Scratchbox (cross-compiler) on a Linux (Ubuntu) machine.
Hardware: BeagleBoard (ARM Cortex-A8 with IMG POWERVR SGX).
-The source code is based on XBMC for Linux - version 9.11 (Camelot).
+The source code is based on Kodi for Linux - version 9.11 (Camelot).
All lines that are prefixed with the '$' character are commands that need to be typed into a standard linux terminal
All lines that are prefixed with the '>' character are commands that need to be typed into scratchbox
@@ -162,7 +162,7 @@ In order to continue, you will need the SGX SDK from TI's website.
Once you have installed said SDK on a standard Linux machine, copy the neccessary .h and .so files to the appropriate directories in scratchbox:
e.g /scratchbox/users/<username>/targets/<target_name>/usr/include/EGL/egl.h
These files will also need to be transferred over to the board eventually.
-NOTE: XBMC has only been tested with the following versions of the OMAP35x Graphics SDK:
+NOTE: Kodi has only been tested with the following versions of the OMAP35x Graphics SDK:
3.00.00.05, 3.00.00.06, 3.00.00.08, 3.00.00.09
@@ -170,7 +170,7 @@ NOTE: XBMC has only been tested with the following versions of the OMAP35x Graph
6. How to compile
-----------------------------------------------------------------------------
-To create the XBMC executable manually perform these following steps:
+To create the Kodi executable manually perform these following steps:
-----------------------------------------------------------------------------
6.1 Configure & Make:
@@ -179,7 +179,7 @@ To create the XBMC executable manually perform these following steps:
$ ./bootstrap
> ./configure --enable-gles
- This will configure XBMC inside scratchbox ready for compilation on ARM.
+ This will configure Kodi inside scratchbox ready for compilation on ARM.
Because the default is to build for OpenGL, we require the --enable-gles flag to be set for OpenGL ES 2.0.
(Note: No OpenGL ES 1.x available)
Now, build with the following:
@@ -191,12 +191,12 @@ To create the XBMC executable manually perform these following steps:
-----------------------------------------------------------------------------
There is no need to do 'make install' as we dont want it installed into scratchbox.
- There is also the slight problem of the fact that scratchbox's 'find' command is outdated and wont execute xbmc's 'make install' correctly.
+ There is also the slight problem of the fact that scratchbox's 'find' command is outdated and wont execute Kodi's 'make install' correctly.
Instead, use the provided shell script:
> cd /tools/arm/arm-scripts/
> ./create-xbmcfile.sh
- This will create a tar file tools/arm/arm-scripts/xbmc.tar.bz2 containing the xbmc files, ready for you to transfer to the board.
+ This will create a tar file tools/arm/arm-scripts/xbmc.tar.bz2 containing the Kodi files, ready for you to transfer to the board.
-----------------------------------------------------------------------------
@@ -238,14 +238,14 @@ It is also assumed that you have it setup with either Angstrom or Ubuntu.
# tar xjf armel-pkgs.tar.bz2 -C /
# tar xjf xbmc.tar.bz2 -C /usr/
- After this initial setup, during development, you should only need to replace /usr/share/xbmc/xbmc.bin with the newly created binary.
+ After this initial setup, during development, you should only need to replace /usr/share/kodi/kodi.bin with the newly created binary.
-----------------------------------------------------------------------------
- 7.3 Running XBMC:
+ 7.3 Running Kodi:
-----------------------------------------------------------------------------
- Now, run XBMC by executing the binary:
- # /usr/share/xbmc/xbmc.bin
+ Now, run Kodi by executing the binary:
+ # /usr/share/kodi/kodi.bin
Run the binary and not the script as the script will fail.
@@ -256,7 +256,7 @@ It is also assumed that you have it setup with either Angstrom or Ubuntu.
If it fails to run correctly, there are a few things to try out.
First, is there any helpful output on the terminal?
-Check the log file, usually located ~/.xbmc/temp/xbmc.log
+Check the log file, usually located ~/.kodi/temp/kodi.log
It may have failed because of a missing package.
If so, you will need to download the appropriate armel package from packages.debian.org,
Extract the files with the command: dpkg-deb -x packagename.deb /path/to/extract/to
@@ -264,10 +264,10 @@ Then tarball the extracted files: tar cjf pkg.tar.bz2 /path/to/extracted/files
Then transfer them to the board, and extract: tar xjf pkg.tar.bz2
This is because the .deb files cannot be extracted in Angstrom.
-If this is not the case, try various different parameters for xbmc.bin such as:
-xbmc.bin --standalone
-xbmc.bin -p
-xbmc.bin -fs
-Or build with debug for a more in-depth xbmc.log file by ommitting the line --disable-debug on configure.
+If this is not the case, try various different parameters for kodi.bin such as:
+kodi.bin --standalone
+kodi.bin -p
+kodi.bin -fs
+Or build with debug for a more in-depth kodi.log file by ommitting the line --disable-debug on configure.
Feel free to contact me on mcgeagh@xbmc.org
diff --git a/docs/README.raspberrypi b/docs/README.raspberrypi
index aadcc418c7..5b9729825a 100644
--- a/docs/README.raspberrypi
+++ b/docs/README.raspberrypi
@@ -14,22 +14,22 @@ crosscompile environment.
2. Installing and setting up the buildroot environment
-----------------------------------------------------------------------------
-Create a top level directory where you checkout xbmc and buildroot.
+Create a top level directory where you checkout Kodi and buildroot.
For example :
-mkdir /opt/xbmc-raspberrypi
-cd /opt/xbmc-raspberrypi
+mkdir /opt/kodi-raspberrypi
+cd /opt/kodi-raspberrypi
Checkout xbmc :
-git clone https://github.com/xbmc/xbmc.git
+git clone https://github.com/xbmc/xbmc.git kodi
Checkout buildroot :
git clone https://github.com/huceke/buildroot-rbp.git
-cd /opt/xbmc-raspberrypi/buildroot-rbp
+cd /opt/kodi-raspberrypi/buildroot-rbp
-Follow the instructions in README.rbp how to build the system and xbmc.
+Follow the instructions in README.rbp how to build the system and Kodi.