README

Limbo PC Emulator (QEMU x86) for Android    

================================================================================

1. What is Limbo?

Limbo is a QEMU-based emulator for Android. It currently supports PC emulation 
for Intel x86 architecture.
For more information visit:
https://code.google.com/p/limbo-android/
    

===============================================================================

2. Requirements:

    Android SDK
    Android NDK r8
    Eclipse + Eclipse Android plugin or Netbeans + Android plugin
    An Android device (most stock/custom roms should be compatible)

===============================================================================

3. Known Issues:
	See https://code.google.com/p/limbo-android/issues/list
	
===============================================================================
3. Setup

    Configure variables for toolchain and NDK directories for your device
     in jni/android-config.mak.
    Configure your PATH variable add the NDK Directory so makefile can find ndk-build
    

===============================================================================
4. Build

    a. To build the app make sure you're under the root directory:
        $> cd /home/youraccount/.../limbo-android

    b. Build the static and shared libraries :
        
        Change directory to ./jni and type:
        make 
        	
    c. Build the Android APK (Limbo.apk) from Eclipse or Netbeans.
    		 
    	** Make sure the *.so libraries are zipped in the final .apk
    	(Eclipse should do that automatically) 
    	
   	d. Build the debugging version:
   		i. Modify debuggable flag in AndroidManifest.xml to true
   		ii. Modify android-config.mak and point to a configuration 
   			with no optimization: 
   			ie android-generic-armv5te-softfp-noopt.mak
   		ii. From the command line type:
   			make NDK_DEBUG=1
   			
    e. If you want to build the ARM Emulator update qemu.config.mak file:
    TARGET_LIST = arm-softmmu
    
    f. For ARMv7 phones:
        i. Update android-config.mak and include file android-generic-armv7a-vfpv3d16.mak 
        ii. make

    g. For x86 phones:
        i. Update android-config.mak and include file android-ndkr8-x86.mak 
        ii. make

	h. Deploy to different package (Optional) 
        i. Rename all R references using eclipse 
        	Menu Bar => "Search" => "Replace"
        	ie:
        	Search for: "import com.max2idea.android.limbo.main"
        	Replace with: "import com.max2idea.android.limbo.mainarmv7"
        ii. Re-Link Androidmanifest.xml to a different manifest file
        	ie:
   			ln -s manifest/AndroidManifestARMv7.xml Androidmanifest.xml 
   
    i. To clean up type:
    	make ultraclean
    	
===============================================================================
5. Run
	a. Recommend installing a full Qwerty keyboard for Android (ie Hacker's keyboard 
		from the Google Android store) 
	b. Start the Limbo app and choose CPU, Memory (~8-64MB),etc..
	c. Choose a bootable disk image(s) for CDRom, Floppy, and a HDD image
	d. Start the virtual machine.
    e. Have fun!
    	
===============================================================================
6. License
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

===============================================================================

Copyright � 2012 Max Kastanas

Endofdoc