[osx/ios] update readmes

1 files changed, 72 insertions, 15 deletions

diff --git a/docs/README.ios b/docs/README.ios
index aac3a73a49..e4704c5391 100644
--- a/docs/README.ios
+++ b/docs/README.ios
@@ -7,14 +7,16 @@ TOC
 4. How to compile and run
 	4.1 Using XCode
 	4.2 Using Command line
-5. Gesture Handling on iPad/iPhone/iPod touch
+5. Packaging
+6. Gesture Handling on iPad/iPhone/iPod touch
+7. Remote control on ATV2
 
 -----------------------------------------------------------------------------
 1. Introduction
 -----------------------------------------------------------------------------
 
 This is a platform port of XBMC for the Apple iOS operating system. 
-The current build system is Xcode 3.x and iOS SDK 4.2/4.3 
+The current build system supports Xcode 3.2.6 or Xcode 4.3.x with iOS SDK 4.2/4.3/5.1
 There are two ways to build XBMC for Mac.
 
 1) command-line or
@@ -23,7 +25,7 @@ There are two ways to build XBMC for Mac.
 Generally, Xcode is the easiest as it presents the build system in a GUI environment.
 The command-line build is still under development.
 
-XBMC for Mac is composed of a main binary with numerous dynamic libraries and
+XBMC for iOS is composed of a main binary with numerous dynamic libraries and
 codecs that support a multitude of music and video formats.
 
 NOTE TO NEW OS X USERS: All lines that are prefixed with the '$' character are
@@ -43,17 +45,27 @@ character itself should NOT be typed as part of the command.
 -----------------------------------------------------------------------------
 3.0 Install Xcode
 -----------------------------------------------------------------------------
-Install latest Xcode. You can download it from Apple's site after registration at
-(http://developer.apple.com/tools/download). 
-The preferred version is Xcode 3.2.5 and iOS SDK 4.2.
+Install latest Xcode (4.3.2 or 3.2.6 as of the writing). You can download it from 
+
+1. Apple's site after registration at http://developer.apple.com/tools/download (Xcode 3.2.6)
+2. In the MacOSX AppStore (Xcode 4.3.x). 
+
+If you are using XCode 4.3.x you also need to install the "Command Line Tools". To do so
+after installing Xcode you have to go to "Xcode->Preferences->Downloads" and install the
+package "Command Line Tools".
+
+Xcode 3.2.6 only runs on 10.6.x (Snow Leopard). 
+Xcode 4.3.x only runs on 10.7.x (Lion).
+
+The preferred iOS SDK Version is 4.3 (when using Xcode 3.2.6) or 5.1 (when using
+Xcode 4.3.x).
 
 -----------------------------------------------------------------------------
 3.1 Install Cross libs and runtime environment
 -----------------------------------------------------------------------------
 
  $ cd $HOME/XBMC
- $ sudo mkdir -p /usr/local/bin; sudo cp tools/darwin/depends/gas-preprocessor/gas-preprocessor.pl /usr/local/bin/
- $ cd tools/darwin/depends
+  $ cd tools/darwin/depends
  $ ./bootstrap
  $ ./configure --with-darwin=ios
  $ make
@@ -83,17 +95,62 @@ end not simulator.
 -----------------------------------------------------------------------------
 
  $ cd $HOME/XBMC
- $ xcodebuild -project XBMC-IOS.xcodeproj -target XBMC -configuration Release build ONLY_ACTIVE_ARCH=YES ARCHS=armv7 VALID_ARCHS=armv7 IPHONEOS_DEPLOYMENT_TARGET=4.1 SDKROOT=iphoneos4.2
+ $ xcodebuild -project XBMC-IOS.xcodeproj -target XBMC -configuration Release build \
+   ONLY_ACTIVE_ARCH=YES ARCHS=armv7 VALID_ARCHS=armv7 IPHONEOS_DEPLOYMENT_TARGET=4.1 \
+   SDKROOT=iphoneos4.2
 
 or
 
- $ xcodebuild -project XBMC-ATV2.xcodeproj -target XBMC -configuration Release build ONLY_ACTIVE_ARCH=YES ARCHS=armv7 VALID_ARCHS=armv7 IPHONEOS_DEPLOYMENT_TARGET=4.1 SDKROOT=iphoneos4.2
+ $ xcodebuild -project XBMC-ATV2.xcodeproj -target XBMC -configuration Release build \
+  ONLY_ACTIVE_ARCH=YES ARCHS=armv7 VALID_ARCHS=armv7 IPHONEOS_DEPLOYMENT_TARGET=4.1 \
+  SDKROOT=iphoneos4.2
+ 
+ Make sure to set SDKROOT to the iOS SDK you want to use.
+
+-----------------------------------------------------------------------------
+5. Packaging
+-----------------------------------------------------------------------------
+
+This section describes how to package XBMC in a deb image for
+distribution.
 
+  1. build XBMC for iOS or ATV2 from XCode so that the application bundle is 
+     correctly updated.
 
-5. Gesture Handling on iPad/iPhone/iPod touch
+  2. 
+   $ cd tools/darwin/packaging/xbmc-atv2
+   or
+   $ cd tools/darwin/packaging/xbmc-ios
 
-double finger swipe left -> back
-double finger tap -> right mouse
-single finger tap -> left mouse
-panning, and flicking ->  panning and flicking works for media lists only at the moment ... scrollbars and other stuff are only clickable (single tap), for now
+  3. $ ./mk-xbmc-atv2.sh release
+     or
+     $ ./mk-xbmc-ios.sh release
+     
+  4. Use release or debug - you have to be sure that you build the corresponding 
+     version before.
+  
+  5. The resulting deb file can be copied to the iOS/ATV2 via ssh/scp and then be 
+     installed manually. For this you need to ssh into the iOS/ATV2 and do:
+     $ dpkg -i <name of the deb file>
+
+-----------------------------------------------------------------------------
+6. Gesture Handling on iPad/iPhone/iPod touch
+-----------------------------------------------------------------------------
+
+ - double finger swipe left                   -> back
+ - double finger tap/single finger long tap   -> right mouse
+ - single finger tap                          -> left mouse
+ - panning, and flicking                      -> for navigating in lists
+ - dragging                                   -> for scrollbars and sliders
+ - zoom gesture                               -> in the pictureviewer
+
+-----------------------------------------------------------------------------
+7. Remote control on ATV2
+-----------------------------------------------------------------------------
 
+ - Select             -> like enter/left click - OK button on other remotes (during playback its pause by defaul)
+ - Select long press  -> During playback show the overlay
+ - Cursor keys        -> for moving around and selecting controls
+ - Menu               -> back
+ - Menu long press    -> context menu
+