Coron Tutorials

Author: duanqizhi

Coron-Developer-Guide.pdf

@@ -0,0 +1,191 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source form
+of the Work, excluding those notices that do not pertain to any part of the
+Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same "printed page" as the copyright notice for easier identification within
+third-party archives.
+
+   Copyright [2014] [Coron]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

Coron-video.webm

@@ -0,0 +1,125 @@
+1. 介绍
+====
+<b>Coron</b>是一个致力于开源ROM制作的项目, 开源了制作百度云OS 的所有工具和部分示例机型。采用Apache License 2.0协议, 为乐于分享的开发者提供最大的自由度。
+
+开源项目的访问网址是 https://github.com/baidurom , 创立纪元是二零一三年八月八日。旨在让更多的开发者体验百度云OS 的制作过程, 感受其间简洁、细节的情怀。
+
+   <b>Coron</b>, 意味着与开发者合作而生的ROM, <b>CO</b>-operation <b>ROM</b>；
+
+   <b>Coron</b>, 意味着百度云OS 强大的云服务, <b>ROM</b> <b>O</b>ver <b>C</b>loud；
+
+   <b>Coron</b>, 也是一个清新纯净的小岛。
+
+
+2. 分支命名
+===
+开源项目的分支命名基于coron, 对于单卡机型, 后缀为Android 版本； 对于双卡机型, 后缀为双卡平台与Andorid版本的结合。
+
+已有单卡分支有coron-4.0, coron-4.1, coron-4.2, coron-4.3, 已有的双卡分支有coron-mtk-4.0, coron-mtk-4.2。 分支对应到可以制作的ROM版本, 譬如, 厂商原来的系统是Android 4.3的单卡版本, 那么, 就推荐使用coron-4.3分支来移植百度云OS 。
+
+开源项目的目录结构如下所示: 
+
+    coron
+     +-- manifest                 开源项目的Repo 管理清单文件
+     +-- build                    编译脚本，包括基于Makfile 编译环境的构建脚本
+     +-- tools                    工具，包括反编译/编译，解包/打包的脚本，以及其他一些实用工具
+     +-- baidu
+          +-- release             Baidu 发布的默认底包，内容定期更新
+          +-- frameworks
+                +-- overlay       资源覆盖，包括Baidu 对原生Android 资源文件的修改
+     +-- devices                  所有的开发机型目录
+          +-- base                基础机型，生成其他机型的Patch，内容定期更新
+          +-- your_device         待开发者适配的机型
+
+
+
+3. 代码下载
+====
+
+通过repo init命令的-b参数, 选择需要下载的分支(譬如coron-4.3)。
+通过repo sync命令同步远程代码: 
+
+    repo init -u https://github.com/baidurom/manifest.git -b coron-4.3
+    repo sync
+
+如果连接一直失败或下载代码过慢，则使用以下命令:
+
+    repo init --repo-url git://github.com/baidurom/repo.git -u https://github.com/baidurom/manifest.git -b coron-4.3 --no-repo-verify
+    repo sync --no-clone-bundle -c -j4
+
+
+4. 百度云OS 移植
+===
+<b>* 一键适配</b>
+
+下载完代码以后, 在开源项目根目录, 执行以下命令初始化开发环境: 
+
+    source build/envsetup.sh
+
+创建一个新的机型工程的目录(以demo为例), 后续的移植都在机型目录完成。
+
+    mkdir -p devices/demo
+    cd devices/demo
+
+通过 USB 线连接 PC 与待开发的手机,或将待移植的原厂底包放置于机型根目录。执行以下命令,便可开始一键适配
+
+    coron fire
+
+一键适配有一些关键的步骤, 该命令会记录当前的执行到的步骤, 如果其中某个步骤执行出错, 只需要根据错误提示解决问题后, 继续执行该命令即可。
+
+    1) config: 从手机或已有的原厂底包中拉取boot.img和recovery.img,生成Makefile;
+    2) newproject: 从手机或已有的原厂底包中拉取原厂的所有文件,构建一个新机型工程;
+    3) patchall: 自动 Patch 需要植入的代码。既插桩;
+    4) autofix: 自动补充缺失的接口,并自动解冲突;
+    5) fullota: 编译机型,生成最终的卡刷包或可以刷入手机的 image。
+
+
+<b>* 冲突处理</b>
+
+自动将百度云OS 涉及到的改动注入厂商的代码中, 可能会存在代码合并冲突。冲突会以下面的形式标注出来, 开发者需要在厂商的文件中手工解决这些冲突。
+
+    <<<<<<< VENDOR
+      原厂的代码块
+    =======
+      百度源码的代码块
+    >>>>>>> BOSP
+
+
+<b>* 版本升级</b>
+
+在适配完一款新机型后, 当百度云 OS 有版本更新时, 会发布最新的代码改动, 通过以下命令, 便能自动升级到最新版本
+
+    coron upgrade
+
+
+5. 交流讨论
+===
+具体机型一般有特定的问题, 等待开发者去解决, 以下文档可以帮助开发者解决一些实际问题：
+
+《Developer-Guide.pdf》, 《Details-to-Smali-Development.pdf》
+
+欢迎加入一起交流讨论适配中的各种问题，我们会有定期的开发者学院课程辅导。
+
+  BBS    : http://bbs.rom.baidu.com/forum-184-1.html
+
+  QQ     : 385386883
+
+
+6. 代码提交
+===
+代码提交有2种方式: 
+
+<b>1) 直接更新Git库</b>
+
+对于具备开源项目管理权限的开发者, 可以直接通过git push命令, 提交代码改动: 
+
+    git push –u origin coron-4.3
+
+在修改后的Git库使用上述命令。origin是远程仓库的别名, 是开发者自定义的, 也可以为其他别名； coron-4.2是改动的Git库所在的分支。
+
+<b>2) 通过Code Review方式提交代码</b>
+
+对于具备GitHub账户的开发者, 可以利用GitHub提供的Pull Request方式, 将代码改动以Code Review的形式, 发送给开源项目的管理者。待Code Review通过后, 代码改动将会合并到提交分支。
+
+为了能够提交代码, 开发者需首先注册GitHub账户, 将baidurom的Git库Fork到自己的账户下； 然后, 对Git库进行代码修改, 发送Pull Request。最后, 在开源项目的管理者收到提交请求时, 会对代码进行Code Review, 如果符合准入标准, 就会将改动代码合并到主干分支中。
+