Add README files for open source release
[manifest/android/binary.git] / README_NEW_SHIELD
1 Welcome to the SHIELD Open Source + Binary Driver Release.
2
3 In this README, you will find sync, build, and flashing instructions.
4
5 ==========
6 HowTo Sync:
7 ==========
8
9 Syncing this release requires git and the repo tool from Google:
10 http://source.android.com/source/downloading.html#installing-repo
11
12 mkdir ~/shield-open-source
13 cd ~/shield-open-source
14 repo init -u git://nv-tegra.nvidia.com/manifest/android/binary.git -b rel-24-uda-r1.1-partner -m tlk/t210.xml
15 repo sync -j5
16
17
18 ==========
19 HowTo Build:
20 ==========
21
22 Building this release requires a Linux build environment configured to
23 build Android: http://source.android.com/source/initializing.html
24
25 Additionally, you will be required to agree to license terms when extracting
26 the binary drivers.
27
28 cd ~/shield-open-source
29 export TOP=`pwd`
30 cd vendor/nvidia/licensed-binaries
31 ./extract-nv-bins.sh
32 cd $TOP
33 . build/envsetup.sh
34 setpaths
35 lunch darcy-userdebug
36 mp dev
37
38
39 ==========
40 HowTo Flash:
41 ==========
42
43 Before flashing images from this build to your SHIELD, connect your SHIELD
44 via USB with the port closest to Fan exhaust to the PC where you built this tree.
45
46 Next, put your SHIELD into fastboot mode using following method:
47 Controller method:
48 1. Connect SHIELD Controller using USB cable
49 2. Use USB port near HDMI port for the Controller and USB port away for PC connection
50 3. Hold Button-A and Button-B on SHIELD Controller and then insert power adapter to SHIELD
51 4. Wait until you see Fastboot menu on HDMI display
52 5. Use X/Y to navigate
53 6. Use A to select
54
55 Fastboot menu navigation:
56 1.  Use X/Y to navigate
57 2.  Use A to select
58
59 If this is the first time you have done this procedure, you must unlock
60 your bootloader. To unlock your bootloader, run the following command
61 in a terminal:
62
63 fastboot oem unlock
64
65 It will take you to '!!! READ THE FOLLOWING !!!' page.
66 Two selectable options are available. 'Confirm' and 'Back to menu'.
67 Select 'Confirm' to unlock the bootloader.
68
69 Your device's bootloader should now be unlocked.
70
71 To flash images from this build to your SHIELD, run the following commands
72 from the same terminal where you did your build:
73
74 fastboot oem dtbname                  (This will print the DTB name for a given product)
75
76 cd $OUT
77 fastboot flash recovery recovery.img
78 fastboot flash boot boot.img
79 fastboot flash system system.img
80 fastboot flash vendor vendor.img
81 fastboot flash dtb <DTB file name>    (Use result from "fastboot oem dtbname" in <DTB file name>)
82 fastboot reboot