Build for capricorn
These instructions will hopefully assist you to start with a stock Xiaomi Mi 5s, 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 Xiaomi Mi 5s
- A relatively recent 64-bit computer (Linux, macOS, or Windows) with a reasonable amount of RAM and about 100 GB of free storage (more if you enable
ccacheor 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 Xiaomi Mi 5s
- A decent internet connection and 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, which stands for “change directory”, the concept of directory hierarchies, and that in Linux they are separated by /, etc.
Build LineageOS and LineageOS Recovery
Install the SDK
If you haven’t previously installed
fastboot, you can download them from Google.
Extract it running:
unzip platform-tools-latest-linux.zip -d ~
Now you have to add
fastboot to your 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
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.
apt-get installcommand directly in the Terminal.
To build LineageOS, 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:
Different versions of LineageOS require different JDK (Java Development Kit) versions.
- LineageOS 16.0: OpenJDK 1.9 (included by default)
- LineageOS 14.1-15.1: OpenJDK 1.8 (install
- LineageOS 11.0-13.0: OpenJDK 1.7 (install
* Ubuntu 16.04 and newer do not have OpenJDK 1.7 in the standard package repositories. See the 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.
Create the directories
You’ll need to set up some directories in your build environment.
To create them:
mkdir -p ~/bin mkdir -p ~/android/lineage
~/bin directory will contain the git-repo tool (commonly named “repo”) and the
~/android/lineage directory will contain the source code of LineageOS.
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
~/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
source ~/.profile to update your environment.
Initialize the LineageOS source repository
The following branches are officially supported for the Xiaomi Mi 5s:
Enter the following to initialize the repository:
cd ~/android/lineage repo init -u https://github.com/LineageOS/android.git -b lineage-16.0
Download the source code
To start the download of the source code to your computer, type the following:
The LineageOS 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
-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. On the other hand,
-c will ask repo to pull in only the current branch instead of all branches that are available on GitHub.
repo synccommand is used to update the latest source code from LineageOS and Google. Remember it, as you may want to do it every few days to keep your code base fresh and up-to-date.
Prepare the device-specific code
After the source downloads, ensure you’re in the root of the source code (
cd ~/android/lineage), then type:
source build/envsetup.sh breakfast capricorn
Extract proprietary blobs
Now ensure your Mi 5s is connected to your computer via the USB cable, with ADB and root enabled, and that you are in the
~/android/lineage/device/xiaomi/capricorn folder. Then run the
The blobs should be pulled into the
~/android/lineage/vendor/xiaomi folder. If you see “command not found” errors,
need to be placed in
Turn on caching to speed up build
Make use of
ccache if you want to speed up subsequent builds by running:
and adding that line to your
~/.bashrc file. Then, specify the maximum amount of disk space you want
ccache to use by typing this:
ccache -M 50G
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
You can also enable the optional
ccache compression. While this may involve a slight performance slowdown, it increases the number of files that fit in the cache. To enable it, run:
or add that line to your
ccachesize can be lower (aim for approximately 20GB for one device).
Start the build
Time to start building! Now, type:
croot brunch capricorn
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:
There you’ll find all the files that were created. The two files of more interest are:
recovery.img, which is the LineageOS recovery image.
lineage-16.0-20190914-UNOFFICIAL-capricorn.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.