✦✦✦ [GUIDE] Build LineageOS ✦ How To use Github ✦✦✦

Search This thread

Top Liked Posts

  • There are no posts matching your filters.
  • 61

    How-to Build LineageOS


    These instructions will hopefully assist you to start with a stock device, unlock the bootloader (if necessary), and then download the required tools as well as the very latest source code for LineageOS (based on Google’s Android operating system) for your device. Using these, you can build both LineageOS and LineageOS Recovery image from source code, and then install them both to your device.

    It is difficult to say how much experience is necessary to follow these instructions. While this guide is certainly not for the very very very uninitiated, these steps shouldn’t require a PhD in software development either. Some readers will have no difficulty and breeze through the steps easily. Others may struggle over the most basic operation. Because people’s experiences, backgrounds, and intuitions differ, it may be a good idea to read through just to ascertain whether you feel comfortable or are getting over your head.

    Remember, you assume all risk of trying this, but you will reap the rewards! It’s pretty satisfying to boot into a fresh operating system you baked at home :). And once you’re an Android-building ninja, there will be no more need to wait for “nightly” builds from anyone. You will have at your fingertips the skills to build a full operating system from code to a running device, whenever you want. Where you go from there– maybe you’ll add a feature, fix a bug, add a translation, or use what you’ve learned to build a new app or port to a new device– or maybe you’ll never build again– it’s all really up to you.

    What you’ll need

    * A device (supported by LineageOS)
    * A relatively recent 64-bit computer (Linux, OS X, or Windows) with a reasonable amount of RAM and about 100 GB of free storage (more if you enable ccache or build for multiple devices). The less RAM you have, the longer the build will take (aim for 8 GB or more). Using SSDs results in considerably faster build times than traditional hard drives.
    * A USB cable compatible with the OnePlus One (typically micro USB)
    * A decent internet connection & reliable electricity :)
    * Some familiarity with basic Android operation and terminology. It would help if you’ve installed custom roms on other devices and are familiar with recovery. It may also be useful to know some basic command line concepts such as cd for “change directory”, the concept of directory hierarchies, that in Linux they are separated by /. etc.


    1. Install SDK
    2. Install build packages
    3. Java
    4. Create the directories
    5. Install the repo command
    6. Initialize the LineageOS source repository
    7. Download the source code
    8.Prepare the device-specific code
    9. Extract proprietary blobs
    10. Turn on caching to speed up build
    11. Configure jack
    12. Start the build
    13. Install the build

    Build LineageOS and LineageOS Recovery​

    1. Install SDK

    If you haven’t previously installed adb and fastboot, you can download them from Google. Extract it using:
    unzip platform-tools-latest-linux.zip -d ~

    Now we have to add adb and fastboot to our path. Open ~/.profile and add the following:

    # add Android SDK platform tools to path
    if [ -d "$HOME/platform-tools" ] ; then

    Then, run this to update your environment.
    source ~/.profile

    2. Install build packages

    Several packages are needed to build LineageOS. You can install these using your distribution’s package manager.

    You’ll need:

    bc bison build-essential ccache curl flex g++-multilib gcc-multilib git gnupg gperf imagemagick lib32ncurses5-dev lib32readline-dev lib32z1-dev liblz4-tool libncurses5-dev libsdl1.2-dev libssl-dev libwxgtk3.0-dev libxml2 libxml2-utils lzop pngcrush rsync schedtool squashfs-tools xsltproc zip zlib1g-dev

    For Ubuntu versions older than 16.04 (xenial), substitute:

    libwxgtk3.0-dev → libwxgtk2.8-dev

    3. Java

    Different versions of LineageOS require different JDK (Java Development Kit) versions.

    LineageOS 11.0-13.0: OpenJDK 1.7 (install openjdk-7-jdk)*
    LineageOS 14.1: OpenJDK 1.8 (install openjdk-8-jdk)

    * Ubuntu 16.04 and newer do not have OpenJDK 1.7 in the standard package repositories. See Ask Ubuntu question How do I install openjdk 7 on Ubuntu 16.04 or higher Note that the suggestion to use PPA openjdk-r is outdated (the PPA has never updated their offering of openjdk-7-jdk, so it lacks security fixes); skip that answer even if it is the most upvoted.

    4. Create the directories

    You’ll need to set up some directories in your build environment.

    To create them:

    $ mkdir -p ~/bin
    $ mkdir -p ~/android/system

    5. Install the repo command

    Enter the following to download the repo binary and make it executable (runnable):

    $ curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo
    $ chmod a+x ~/bin/repo

    Put the ~/bin directory in your path of execution

    In recent versions of Ubuntu, ~/bin should already be in your PATH. You can check this by opening ~/.profile with a text editor and verifying the following code exists (add it if it is missing):

    # set PATH so it includes user's private bin if it exists
    if [ -d "$HOME/bin" ] ; then

    Then, use this to update your environment.

    source ~/.profile

    6. Initialise the LineageOS source repository

    Enter the following to initialize the repository:

    $ cd ~/android/system
    $ repo init -u https://github.com/LineageOS/android.git -b lineage-16.0

    7. Download the source code

    To start the download of the source code to your computer:

    $ repo sync

    The Lineage manifests include a sensible default configuration for repo, which we strongly suggest you use (i.e. don’t add any options to sync). For reference, our default values are -j 4 and -c. The -j 4 part means that there will be four simultaneous threads/connections. If you experience problems syncing, you can lower this to -j 3 or -j 2. -c will ask repo to pull in only the current branch, instead of the entire LineageOS history.

    8. Prepare the device-specific code

    After the source downloads, ensure you’re in the root of the source code (cd ~/android/system), then type:
    You have to change DEVICE with the codename of your device (for example: Oneplus ONE codename is bacon)

    $ source build/envsetup.sh
    $ breakfast "DEVICE"

    This will download your device’s device specific configuration and kernel.

    Important: Some maintainers require a vendor directory to be populated before breakfast will succeed. If you receive an error here about vendor makefiles, jump down to Extract proprietary blobs. The first portion of breakfast should have succeded, and after completing you can rerun breakfast

    9. Extract proprietary blobs

    Method 1
    Now ensure your device is connected to your computer via the USB cable, with ADB and root enabled, and that you are in the ~/android/system/device/your_device/codename folder. Then run the extract-files.sh script:

    $ ./extract-files.sh

    The blobs should be pulled into the ~/android/system/vendor/your_device folder. If you see “command not found” errors, adb may need to be placed in ~/bin.

    Method 2 (Recomended)
    Search for your device blobs on TheMuppets or Donkeycoiote and add them to local manifest

    10. Turn on caching to speed up build

    You can speed up subsequent builds by running:

    $ export USE_CCACHE=1

    And adding that line to your ~/.bashrc file. Then, specify the maximum amount of disk space you want cache to use by typing this from the top of your Android tree:

    $ prebuilts/misc/linux-x86/ccache/ccache -M 50.0G

    Where 50G corresponds to 50GB of cache. This needs to be run once. Anywhere from 25GB-100GB will result in very noticeably increased build speeds (for instance, a typical 1hr build time can be reduced to 20min). If you’re only building for one device, 25GB-50GB is fine. If you plan to build for several devices that do not share the same kernel source, aim for 75GB-100GB. This space will be permanently occupied on your drive, so take this into consideration. See more information about ccache on Google’s Android build environment initialization page.

    11. Configure jack

    Jack is the new Java compiler used from Lineage 14. It is known to run out of memory

    Simple fix is to run this command:

    $ export JACK_SERVER_VM_ARGUMENTS="-Dfile.encoding=UTF-8 -XX:+TieredCompilation -Xmx4096m"

    Adding that command to your ~/.bashrc file will automatically configure Jack to allocate a sufficient amount of memory.
    If this doesn't help, you can reduce the number of Jacks to 1 in config.properties


    12. Start the build

    Time to start building! Now, type:

    $ croot
    $ brunch [COLOR="red"]device[/COLOR]

    Remember, device is the codename for your device

    The build should begin.

    13. Install the build

    Assuming the build completed without errors (it will be obvious when it finishes), type the following in the terminal window the build ran in:

    $ cd $OUT

    There you’ll find all the files that were created. The two files we’re interested in are:

    recovery.img, which is the LineageOS recovery image.
    lineage-14.1-build_date-UNOFFICIAL-device.zip, which is the LineageOS installer package.

    Success! So… what’s next?​

    You’ve done it! Welcome to the elite club of self-builders. You’ve built your operating system from scratch, from the ground up. You are the master/mistress of your domain… and hopefully you’ve learned a bit on the way and had some fun too.
    Now, what to do next? You can jump to next section of this guide to understand how Github works and how to pick some commits from other developers/teams to improve your custom ROM​

    This guide was taken from Official LineageOS wiki and all credits goes to LineageOS Maintainers :D

    What is Github and how to use it

    GitHub is a code hosting platform for version control and collaboration. It lets you and others work together on projects from anywhere. It is a powerful tool with many features available and here i´m going to talk about how you can use it to help you build and customize your "Custom ROM"


    1. Repositories
    2. How to add/remove repositories
    3. How to add/remove remotes
    4. Repository Fork

    1. Repositories

    Now that you have built custom lineage from source to your device, you can explore deeper and see how things work and change them according to your needs.
    First we are going to se what is inside .repo folder

    cd ~/working_dir/.repo

    It will show you something similar to this:


    Inside the .repo folder are the necessary "manifest files" that tell the repo sync command what to include or remove from our project when synchronizing with the source

    Open manifest.xml

     gedit ~/working_dir/.repo/manifest.xml

    Inside that file you have all information about which repositories belongs to source. These are the base repositories to build LineageOS.
    Inside ~/working_dir/.repo/local_manifests/roomservice.xml you can see the repositories needed to build for your specific device. This file is created after breakfast device step and includes, besides others, device tree and kernel.

    2. How to add/remove repositories

    Lets take a look at how we use roomservice.xml to add/remove repo's from our project, i will use Oneplus ONE device tree for example

     <project name="LineageOS/android_device_oneplus_bacon" path="device/oneplus/bacon" remote="github" revision="cm-14.1" />

    * project name="LineageOS/android_device_oneplus_bacon Name of repository (without https://github.com)
    * path="device/oneplus/bacon" Here is where the files will reside in our working directory
    * remote="github" Is the for remote we are using, in this case is github (see below how to add/remove remotes to your project)
    * revision="cm-14.1" Revision is the branch we want to sync


    3. How to add/remove remotes

    <remote fetch="https://github.com" name="github" />

    * remote fetch="https://github.com Url for remote you want to add to your project (in this case, we are working with github)

    * name="github" This is the name for remote

    Now that you understand the concept of repository, you can "fork" one and start making your
    changes and keep it up to date with LineageOS source. For that, you need a Github Account.​

    4. Repository Fork

    In this example, i will fork Oneplus ONE device tree

    1. Create Github Account

    2. Go to https://github.com/LineageOS/android_device_oneplus_bacon and tap on Fork button. After that you can see that repository on you Github account



    3. Now that you have "forked" one repository, you need to edit ~/working_dir/.repo/local_manifests/roomservice.xml and change the default location to your location on your github.[/SIZE]



    This is the basic steps you need to understand how to use Github to keep your code saved and updated. On next section, i will tell you how use Git so you can work on your project and start to pick some cool commits from others projects.
    if I have a unsopported device (zuk z2 pro) how can sobstitute the breakfast and brunch command?

    This thread is for supported devices, that will be my next guide
    For those who struggling why ccache not working when compiling 17.1, read this: stackoverflow.com/questions/59811821/how-to-use-ccache-to-speed-up-compiling-of-aosp
    In gist, you need an extra environment variable compare with previous versions.
Our Apps
Get our official app!
The best way to access XDA on your phone
Nav Gestures
Add swipe gestures to any Android
One Handed Mode
Eases uses one hand with your phone