Introduction

These instructions will hopefully assist you to start with a stock android 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 android device
  • 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 your device (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.
Let’s begin!

Build LineageOS and LineageOS Recovery

Note: You only need to do these steps once. If you have already prepared your build environment and downloaded the source code, skip to Prepare the device-specific code

Install the 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
    PATH="$HOME/platform-tools:$PATH"
fi
Then, run source ~/.profile to update your environment.

Install the 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 curl flex g++-multilib gcc-multilib git gnupg gperf lib32ncurses5-dev lib32readline-gplv2-dev lib32z1-dev libesd0-dev
liblz4-tool libncurses5-dev libsdl1.2-dev libwxgtk2.8-dev libxml2 libxml2-utils lzop pngcrush schedtool squashfs-tools xsltproc zip zlib1g-dev
imagemagick
For Ubuntu 15.10 (wily) and newer, substitute:
  • lib32-readline-gplv2-dev → lib32readline6-dev
For Ubuntu 16.04 (xenial) and newer, substitute:
  • libwxgtk2.8-dev → libwxgtk3.0-dev

Java

Different versions of LineageOS require different JDK (Java Development Kit) versions.
  • LineageOS 11.0-13.0: OpenJDK 1.7 (install openjdk-7-jdk) - for Ubuntu 16.04 and newer, you can obtain OpenJDK 1.7 from the openjdk-r PPA.
  • LineageOS 14.1: OpenJDK 1.8 (install openjdk-8-jdk)

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

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
    PATH="$HOME/bin:$PATH"
fi
Then, run source ~/.profile to update your environment.

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 cm-13.0

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 CM history.

Note: This may take a while, depending on your internet speed. Go and have a beer/coffee/tea/nap in the meantime!


Tip: The repo sync command is used to update the latest source code from LineageOS and Google. Remember it, as you can do it every few days to keep your code base fresh and up-to-date.

Get prebuilt apps (Lineage 11 and below)

To download the prebuilt apps, run:
$ cd ~/android/system/vendor/cm
$ ./get-prebuilts
You won’t see any confirmation- just another prompt. But this should cause some prebuilt apps to be loaded and installed into the source code. Once completed, this does not need to be done again.

Prepare the device-specific code

After the source downloads, ensure you’re in the root of the source code (cd ~/android/system), then type:
$ source build/envsetup.sh
$ breakfast manta
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

Extract proprietary blobs

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/samsung/manta folder. Then run the extract-files.sh script:
$ ./extract-files.sh
The blobs should be pulled into the ~/android/system/vendor/samsung folder. If you see “command not found” errors, adb may need to be placed in ~/bin.

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 50G
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.

Start the build

Time to start building! Now, type:
$ croot
$ brunch manta
The build should begin.

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:
  1. recovery.img, which is the LineageOS recovery image.
  2. lineage-13.0-20170122-UNOFFICIAL-manta.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.

Share To:
Magpress

LineageOS Team

We are trying hard to provied Lineage os rom for every possible device.To support us like our facebook page and follow on facebook.

50 comments so far,Add yours

  1. the content of this page is not displaying properly in chrome,Some boxes last line contents are not viewing.

    ReplyDelete
    Replies
    1. Seems like some elements on this page has negative "margin-top" value which cause elements overlap and hide some text from previous elements. Hope they'll fix it.

      Delete
    2. https://forum.xda-developers.com/chef-central/android/how-to-build-lineageos-14-1-t3551484

      Delete
  2. 1. Portions of this page are not displaying correctly on FireFox, Chrome, and IE.
    2. Where on this page are the instructions for building a LineageOS ROM for a new device?

    ReplyDelete
    Replies
    1. https://forum.xda-developers.com/chef-central/android/how-to-build-lineageos-14-1-t3551484

      Delete
  3. I'm trying to build LineageOS for my old Moto Defy+ (jordan_plus) but it seems to be unsupported. Am I really out of luck ?

    This is breakfest jordan_plus output:

    including vendor/cm/vendorsetup.sh
    build/core/product_config.mk:238: *** Can not locate config makefile for product "lineage_jordan_plus". Stop.
    Device jordan_plus not found. Attempting to retrieve device repository from LineageOS Github (http://github.com/LineageOS).
    Found repository: android_device_motorola_jordan_plus
    Default revision: cm-14.1
    Checking branch info
    Default revision cm-14.1 not found in android_device_motorola_jordan_plus. Bailing.
    Branches found:
    gingerbread
    Use the ROOMSERVICE_BRANCHES environment variable to specify a list of fallback branches.
    build/core/product_config.mk:238: *** Can not locate config makefile for product "lineage_jordan_plus". Stop.

    ** Don't have a product spec for: 'lineage_jordan_plus'
    ** Do you have the right repo manifest?

    ** Warning: 'jordan_plus' is using CM-based makefiles. This will be deprecated in the next major release.
    build/core/product_config.mk:238: *** Can not locate config makefile for product "cm_jordan_plus". Stop.
    Device jordan_plus not found. Attempting to retrieve device repository from LineageOS Github (http://github.com/LineageOS).
    Found repository: android_device_motorola_jordan_plus
    Default revision: cm-14.1
    Checking branch info
    Default revision cm-14.1 not found in android_device_motorola_jordan_plus. Bailing.
    Branches found:
    gingerbread
    Use the ROOMSERVICE_BRANCHES environment variable to specify a list of fallback branches.
    build/core/product_config.mk:238: *** Can not locate config makefile for product "cm_jordan_plus". Stop.

    ** Don't have a product spec for: 'cm_jordan_plus'
    ** Do you have the right repo manifest?




    ReplyDelete
    Replies
    1. Can you please please make lineage os ROM for my tab3 lite sm t110

      Delete
  4. Please admin make a video tutorial for this.

    ReplyDelete
    Replies
    1. Here you go:
      Part 1: https://www.youtube.com/watch?v=iZmjOlUq_3c
      Part 2: https://www.youtube.com/watch?v=MGI3NSJFtKA
      Part 3: https://www.youtube.com/watch?v=AJCgOHtli64





























      Delete
  5. wow...amazing tutorial !
    thank q

    ReplyDelete
  6. Oooo thanks i am going to build for my galaxy j2

    ReplyDelete
    Replies
    1. hi, have you made one for the J2 ?

      Delete
  7. please make a tutorial for windows 10

    ReplyDelete
    Replies
    1. You can't build Android on Windows 10. Install Ubuntu in a Virtual Machine like VirtualBox.

      Delete
  8. Actually, this is not working for ANY devices. For example my mi5s still not supported.

    ReplyDelete
  9. i wish anyone could make a build for the galaxy note 4 exynos 910c/h

    ReplyDelete
  10. Infocus m350
    Plz make build for it

    ReplyDelete
  11. Coolpad note 3 ends in error 7 please solve it and make a bugless lineage os

    ReplyDelete
  12. The key point here is that you say run the extract-files.sh script. However, if your device is not supported it doesn't tell you how to update the script to list the files that need extracting for your device.

    ReplyDelete
    Replies
    1. Thanks man, you saved me a lot of vain effort. The title is misleading.

      Delete
  13. DO we need to have minimum 8GB RAM for building ? It is giving me
    insufficient memory error. I'm trying to compile with 4 GB RAM.

    ReplyDelete
  14. Somewhat misleading title. It is not for _any_ device, it is for _supported_ devices. My Allwinner A23 based tablet for example is not.

    ReplyDelete
  15. Please build this os for Vkworld T1 Plus

    ReplyDelete
  16. I tried to build my rom for OnePlusOne. Everything was ok, but no mobile data after installation. Can someone say me how to do? Thanks!!

    ReplyDelete
    Replies
    1. you have replace some files for mobile data from stock rom to ur new rom.

      Delete
    2. Thank you! Can you tell me which files and how to? :)

      Delete
  17. for ubuntu 15.04and greater have also have to replace -->

    ReplyDelete
  18. sorry !!
    replace libwxgtk2.8-dev with libwxgtk3.0-dev

    ReplyDelete
  19. Thanks all!! Yes, I did both things, Extract proprietary blobs and replace libwxgtk, the rom compilation arrives at the end, but "no radio image in input target_files; not flashing radio". How do flash radio in the rom?

    ReplyDelete
  20. Replies
    1. I'm trying at the moment, you can pm me on reddit @the_forgotten_king and I can tell you if I succeed

      Delete
  21. Please make a video to build the lineage os

    ReplyDelete
  22. "bc bison build-essential curl flex g++-multilib gcc-multilib git gnupg gperf lib32ncurses5-dev lib32readline-gplv2-dev lib32z1-dev libesd0-dev
    liblz4-tool libncurses5-dev libsdl1.2-dev libwxgtk2.8-dev libxml2 libxml2-utils lzop pngcrush schedtool squashfs-tools xsltproc zip zlib1g-dev
    imagemagick" command gives me

    File bison is unavailable.

    and

    bash: liblz4-tool: command not found

    ReplyDelete
    Replies
    1. Its not a command, its a list of programs you have to install using sudo apt-get install (name of the program)

      Delete
    2. thank you, I have just (couple of dayes before) figured that out

      Delete
  23. After installation the sim card failed to read the signal but i can do text and call but i can't use mobile data does anyone know how to fix this? LineageOS can u help me

    ReplyDelete
  24. please i need lineage 14.1 for lenovo a1000 help me

    ReplyDelete
  25. Can someone make a lineage running with 3.10.72 kernel and for mt65xx device? I got a very slow internet, and I am not sure if I could do the instruction.

    We are stuck at Android 5.1 with kernel 3.10.72, And the roms nowadays uses the 3.4.x kernel. Even the mt6582 have a lineage rom now, while mt6592 with 3.10.72 doesn't have anything.

    ReplyDelete
  26. i'm using kultfor 10 nd if anyonefor did a lineagegreat os for that...plz inform me prabhuarvg@gmail.com...seems like there are no custom roms online expect the marsmellow stock os...

    ReplyDelete
  27. It's failing for my wiko. Shall I replace "breakfast manta" with something else ?

    ReplyDelete
    Replies
    1. yes replace manta with your device codename

      Delete
  28. They copied this from:
    https://forum.xda-developers.com/chef-central/android/how-to-build-lineageos-14-1-t3551484
    That's why there is missing text.

    ReplyDelete

Back To Top