blob: 9a4fa8008e2651688b3e9c23d35b08418a4c3230 [file] [log] [blame]
Dark Eyes777e3e02015-12-04 14:30:35 -05001<img src="https://raw.github.com/BlissRoms/platform_manifest/mm6.0/bliss-logo.png">
Lars Greissfd74a6b2013-11-01 02:00:14 +01002
Dark Eyes777e3e02015-12-04 14:30:35 -05003Getting Started
Lars Greissfd74a6b2013-11-01 02:00:14 +01004---------------
5
Dark Eyes777e3e02015-12-04 14:30:35 -05006To get started with Android/Bliss, you'll need to get
7familiar with [Git and Repo](http://source.android.com/source/using-repo.html).
Lars Greissfd74a6b2013-11-01 02:00:14 +01008
Dark Eyes777e3e02015-12-04 14:30:35 -05009To initialize your local repository using the Bliss trees, use this command:
Lars Greissfd74a6b2013-11-01 02:00:14 +010010
Lars Greiss1bdc5e22013-11-27 19:49:17 +010011
Dark Eyes777e3e02015-12-04 14:30:35 -050012 repo init -u https://github.com/BlissRoms/platform_manifest.git -b mm6.0
Lars Greiss1bdc5e22013-11-27 19:49:17 +010013
Dark Eyes777e3e02015-12-04 14:30:35 -050014Then to sync up:
Lars Greiss1bdc5e22013-11-27 19:49:17 +010015
Dark Eyes777e3e02015-12-04 14:30:35 -050016 repo sync -j#
Lars Greiss1bdc5e22013-11-27 19:49:17 +010017
Dark Eyes777e3e02015-12-04 14:30:35 -050018This(j#) depends on number of cpu cores - use just "repo sync" if you are unsure.
Lars Greissfd74a6b2013-11-01 02:00:14 +010019
Dark Eyes777e3e02015-12-04 14:30:35 -050020To build for your device.
Lars Greissfd74a6b2013-11-01 02:00:14 +010021
Dark Eyes777e3e02015-12-04 14:30:35 -050022. build/envsetup.sh
Lars Greissfd74a6b2013-11-01 02:00:14 +010023
Dark Eyes777e3e02015-12-04 14:30:35 -050024breakfast `device name here`
Lars Greissfd74a6b2013-11-01 02:00:14 +010025
Dark Eyes777e3e02015-12-04 14:30:35 -050026brunch `device name here`
27
28or make it all in one line.
29
30. build/envsetup.sh && breakfast `device name here` && brunch *device name here*
31
32For more information on this Github Organization and how it is structured,
33please [read the wiki article](http://wiki.cyanogenmod.org/w/Github_Organization)
34
35***
36
37Using Build Script
Lars Greissfd74a6b2013-11-01 02:00:14 +010038------------------
39
Dark Eyes777e3e02015-12-04 14:30:35 -050040run command ". build.sh" and follow the command prompts.
Lars Greissfd74a6b2013-11-01 02:00:14 +010041
Lars Greissfd74a6b2013-11-01 02:00:14 +010042
Dark Eyes777e3e02015-12-04 14:30:35 -050043GERRIT
44------
45review.blissroms.com
Lars Greissfd74a6b2013-11-01 02:00:14 +010046
Dark Eyes777e3e02015-12-04 14:30:35 -050047If you would like to contribute to the blissrom project submit patches to:
48`review.blissroms.com`. Then head into the project and clone it locally make changes and push back to bliss review.
Lars Greissfd74a6b2013-11-01 02:00:14 +010049
Dark Eyes777e3e02015-12-04 14:30:35 -050050HOW TO SUBMIT TO OUR GERRIT:
Lars Greissfd74a6b2013-11-01 02:00:14 +010051
Dark Eyes777e3e02015-12-04 14:30:35 -050052First and foremost, setup your github with out Gerrit.
Lars Greissfd74a6b2013-11-01 02:00:14 +010053
Dark Eyes777e3e02015-12-04 14:30:35 -050054Clone the repo you would like to commit to from the Gerrit [Project List](http://review.blissroms.com:8081/#/admin/projects/)
55 -Select from the list and copy clone command line.
Lars Greissfd74a6b2013-11-01 02:00:14 +010056
Dark Eyes777e3e02015-12-04 14:30:35 -050057Make sure you have git review installed
58 - sudo apt-get install git-review
59
60Make sure you are on the correct branch----mm6.0
Lars Greissfd74a6b2013-11-01 02:00:14 +010061
Dark Eyes777e3e02015-12-04 14:30:35 -050062Make your change and commit it
Lars Greissfd74a6b2013-11-01 02:00:14 +010063
Dark Eyes777e3e02015-12-04 14:30:35 -050064Now just type git review, if it does not have the remote yet it will automatically add it and just answer yes to its questions. It will push to the gerrit for you.
Lars Greissfd74a6b2013-11-01 02:00:14 +010065
Dark Eyes777e3e02015-12-04 14:30:35 -050066BLISS BUILD FLAGS
67-----------------
68
69These can be added to your device trees BoardConfig.mk
70
71`BLISS_STRICT:= true` "run strict aliasing"
72
73`BLISS_O3 := true` run "O3 optimizations on build"
74
75`BLISS_GRAPHITE := true` "run Graphite optimiations on build"
76
77`BLISS_KRAIT := true` "run krait optimizations on build-- CPU specific, please verify if you can use this"
78
79`BLISS_PIPE := true` "This flag actually has no effect on the generated code, but it makes the compilation process faster."
80
81`TARGET_TC_ROM := "@@"` Specify toolchain for Rom to be compiled with
82
83`TARGET_TC_KERNEL := "@@"` Specify toolchain for kernel to be complied with.
84
85@@= Toolchains are located in prebuilts/gcc/linux-x86/arm You only need to specify the end number be it 4.8-sm for 4.8 SaberMod Toolchain, this goes for both ROM and KERNEL.
86
87If you use TARGET_TC_ROM and/or TARGET_TC_KERNEL, please add the following to BoardConfig.mk as well
88
89`TARGET_GCC_VERSION_EXP := $(TARGET_TC_ROM)`
90
91`TARGET_KERNEL_CUSTOM_TOOLCHAIN := $(TARGET_TC_KERNEL)`
92
93Last but not least, add this line to end of BoardConfig.mk `-include vendor/bliss/config/sm.mk`